API Reference

Order41 - B2B Buying and Selling. Just Better.

We use GraphQL for serving our API, for inforamtion on about the Query Language itself please check out the official documentation

The API is served under https://api.order41.com for testing end development purposes we do suggest to uese our sandbox environment and its it's playground under https://api.o41.io/graphiql

Contact

Order41 Support

support@order41.com

API Endpoints
# Production Server:
https://api.order41.com
# Sandbox Server:
https://api.o41.io
Headers
# Your API token. Should be included in all API calls.
Authorization: <YOUR_TOKEN_HERE>
Version

7.26.0

Authentication

Every user of the platform, buyer or seller, can query our api to automate their workflows or integrate with other tools they use.

For testing and development purposes we highly recommend to use our sandbox environment. Short lived Authentication tokens can be retrieved with your accounts details via the login mutation

To receive a test account or long lived API tokens please reach out.

Queries

_getDropMeta

Response

Returns a DropMeta

Arguments
Name Description
id - ID ID of the Drop
urlkey - String urlkey of the Drop

Example

Query
query _getDropMeta(
  $id: ID,
  $urlkey: String
) {
  _getDropMeta(
    id: $id,
    urlkey: $urlkey
  ) {
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    productFilters {
      ...DropProductFilterFragment
    }
  }
}
Variables
{
  "id": "4",
  "urlkey": "abc123"
}
Response
{
  "data": {
    "_getDropMeta": {
      "orderItemsQty": 123.45,
      "orderQty": 987,
      "orderTotal": 987.65,
      "orderTotalArray": [OrderTotal],
      "productFilters": [DropProductFilter]
    }
  }
}

_listBrandsMeta

Description

Retrieve meta data for a listBarnds query

Response

Returns a BrandsMeta

Arguments
Name Description
filter - IndustryBrandFilter Filters to be applied on the brands query. Default = {}

Example

Query
query _listBrandsMeta($filter: IndustryBrandFilter) {
  _listBrandsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listBrandsMeta": {"count": 123}}}

_listCartsMeta

Description

Get a list of carts

Response

Returns a CartMeta

Arguments
Name Description
filter - CartFilter Filters to be applied to the notification query

Example

Query
query _listCartsMeta($filter: CartFilter) {
  _listCartsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": CartFilter}
Response
{"data": {"_listCartsMeta": {"count": 123}}}

_listConnectRequestsMeta

Description

Get a meta data for a list of connect requests for the current user

Response

Returns a ListConnectRequestsMeta

Arguments
Name Description
filter - ConnectRequestModelFilter Filters to be applied on the connect requests query. Default = {}

Example

Query
query _listConnectRequestsMeta($filter: ConnectRequestModelFilter) {
  _listConnectRequestsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listConnectRequestsMeta": {"count": 123}}}

_listContactsMeta

Description

Retrieve metadata for a list of contacts

Response

Returns a ContactsMeta

Arguments
Name Description
filter - ContactFilter Conditions for filter contact results

Example

Query
query _listContactsMeta($filter: ContactFilter) {
  _listContactsMeta(filter: $filter) {
    accessCount
    count
  }
}
Variables
{"filter": ContactFilter}
Response
{"data": {"_listContactsMeta": {"accessCount": 987, "count": 987}}}

_listDiscountsMeta

Description

Meta data for a list of discounts

Response

Returns a DiscountsMeta

Arguments
Name Description
filter - DiscountFilter Filters to be applied to the discounts query. Default = {}

Example

Query
query _listDiscountsMeta($filter: DiscountFilter) {
  _listDiscountsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listDiscountsMeta": {"count": 123}}}

_listDropsMeta

Description

Retrieve meta data for a listDrops query

Response

Returns a DropsMeta

Arguments
Name Description
filter - DropFilter Filters to be applied on the drops query. Default = {}

Example

Query
query _listDropsMeta($filter: DropFilter) {
  _listDropsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listDropsMeta": {"count": 987}}}

_listEventsMeta

Description

Meta information for the events list.

Response

Returns an EventsMeta

Arguments
Name Description
filters - EventFilter Filters to be applied on the events query. Default = {}

Example

Query
query _listEventsMeta($filters: EventFilter) {
  _listEventsMeta(filters: $filters) {
    count
  }
}
Variables
{"filters": {}}
Response
{"data": {"_listEventsMeta": {"count": 123}}}

_listIndustriesMeta

Description

Retrieve meta data for a listIndustries query

Response

Returns an IndustriesMeta

Arguments
Name Description
filter - IndustryFilter Filters to be applied on the industries query. Default = {}

Example

Query
query _listIndustriesMeta($filter: IndustryFilter) {
  _listIndustriesMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listIndustriesMeta": {"count": 987}}}

_listNotificationsMeta

Description

Get metadata for a list of notifications

Response

Returns a ListNotificationsMeta

Arguments
Name Description
filter - NotificationFilter Filters to be applied to the notification query. Default = {}

Example

Query
query _listNotificationsMeta($filter: NotificationFilter) {
  _listNotificationsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listNotificationsMeta": {"count": 123}}}

_listOrdersMeta

Response

Returns an OrdersMeta

Arguments
Name Description
filter - OrderFilter filtering options for orders. Default = {}

Example

Query
query _listOrdersMeta($filter: OrderFilter) {
  _listOrdersMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listOrdersMeta": {"count": 987}}}

_listPlansMeta

Description

Retrieve meta data for a listPlans query

Response

Returns a PlansMeta

Arguments
Name Description
filter - PlanFilter Filters to be applied on the query reesults. Default = {}

Example

Query
query _listPlansMeta($filter: PlanFilter) {
  _listPlansMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listPlansMeta": {"count": 123}}}

_listPricelistsMeta

Description

Meta data for a list of pricelists

Response

Returns a PricelistsMeta

Arguments
Name Description
filter - PricelistFilter Filters to be applied to the pricelists query. Default = {}

Example

Query
query _listPricelistsMeta($filter: PricelistFilter) {
  _listPricelistsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listPricelistsMeta": {"count": 987}}}

_listProductsMeta

Description

Retrieve meta data for a list of products

Response

Returns a ProductsMeta

Arguments
Name Description
filter - ProductFilter Filters for the product list. Default = {}

Example

Query
query _listProductsMeta($filter: ProductFilter) {
  _listProductsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listProductsMeta": {"count": 123}}}

_listSharedDropsMeta

Description

Retrieve meta data for a listSharedDrops query

Response

Returns a DropsMeta

Arguments
Name Description
filter - DropFilter Filters to be applied on the shared drops query. Default = {}

Example

Query
query _listSharedDropsMeta($filter: DropFilter) {
  _listSharedDropsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"_listSharedDropsMeta": {"count": 123}}}

_listTeamUsersMeta

Response

Returns a TeamUsersMeta

Example

Query
query _listTeamUsersMeta {
  _listTeamUsersMeta {
    count
  }
}
Response
{"data": {"_listTeamUsersMeta": {"count": 123}}}

discoverDrops

Description

Get a list of discoverable drops

Response

Returns [DropWithLink]

Arguments
Name Description
filter - DropFilter Filters to be applied on the discover_drops query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query DiscoverDrops(
  $filter: DropFilter,
  $first: Int,
  $offset: Int
) {
  discoverDrops(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropLink
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0}
Response
{
  "data": {
    "discoverDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 987,
        "archive": true,
        "asset": "xyz789",
        "assets": ["abc123"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "abc123",
        "currencyBuy": "xyz789",
        "currencySell": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "abc123",
        "discounts": [Discount],
        "discoverable": true,
        "dropLink": "abc123",
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [123],
        "id": "4",
        "images": ["abc123"],
        "img": "xyz789",
        "info": "abc123",
        "isPublic": true,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "xyz789",
        "openrate": 987,
        "order": 123,
        "orderItemsQty": 123.45,
        "orderQty": 123,
        "orderTotal": 123.45,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "public": false,
        "publicVisitorCount": 123,
        "rangeDropInt": "xyz789",
        "rangeDropText": "abc123",
        "season": "xyz789",
        "status": 987,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}

discoverDropsMeta

Description

Discoverable drops meta

Response

Returns a DropsMeta

Arguments
Name Description
filter - DropFilter Filters to be applied on the discover_drops_meta query. Default = {}

Example

Query
query DiscoverDropsMeta($filter: DropFilter) {
  discoverDropsMeta(filter: $filter) {
    count
  }
}
Variables
{"filter": {}}
Response
{"data": {"discoverDropsMeta": {"count": 123}}}

drops

Use listDrops instead
Description

Get a list of drops

Response

Returns [Drop]

Arguments
Name Description
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query Drops(
  $first: Int,
  $offset: Int
) {
  drops(
    first: $first,
    offset: $offset
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"first": 25, "offset": 0}
Response
{
  "data": {
    "drops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 987,
        "archive": true,
        "asset": "abc123",
        "assets": ["xyz789"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "abc123",
        "currencySell": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "abc123",
        "discounts": [Discount],
        "discoverable": true,
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [987],
        "id": 4,
        "images": ["abc123"],
        "img": "xyz789",
        "info": "xyz789",
        "isPublic": false,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "xyz789",
        "openrate": 123,
        "order": 987,
        "orderItemsQty": 987.65,
        "orderQty": 987,
        "orderTotal": 987.65,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "products": [Product],
        "public": false,
        "publicVisitorCount": 123,
        "rangeDropInt": "abc123",
        "rangeDropText": "xyz789",
        "season": "abc123",
        "status": 987,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}

exploreDrops

Description

Get a list of suggested drops

Response

Returns [Drop]

Arguments
Name Description
first - Int Number of elemts to retrieve, defaults to 3. Default = 3
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ExploreDrops(
  $first: Int,
  $offset: Int
) {
  exploreDrops(
    first: $first,
    offset: $offset
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"first": 3, "offset": 0}
Response
{
  "data": {
    "exploreDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 987,
        "archive": false,
        "asset": "abc123",
        "assets": ["abc123"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "xyz789",
        "currencySell": "abc123",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "xyz789",
        "discounts": [Discount],
        "discoverable": true,
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [987],
        "id": "4",
        "images": ["xyz789"],
        "img": "abc123",
        "info": "abc123",
        "isPublic": false,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "abc123",
        "openrate": 987,
        "order": 123,
        "orderItemsQty": 123.45,
        "orderQty": 987,
        "orderTotal": 987.65,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "xyz789",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "products": [Product],
        "public": true,
        "publicVisitorCount": 123,
        "rangeDropInt": "abc123",
        "rangeDropText": "abc123",
        "season": "abc123",
        "status": 987,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}

getBackgroundJob

Description

Reject a connect request

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! bg job id

Example

Query
query GetBackgroundJob($id: ID!) {
  getBackgroundJob(id: $id) {
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getBackgroundJob": {
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": "4",
      "orderId": "4",
      "result": "xyz789",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

getCart

Description

Get single Cart by ID or urlkey

Response

Returns a Cart

Arguments
Name Description
id - ID ID of the Cart
urlkey - String urlkey of the Cart

Example

Query
query GetCart(
  $id: ID,
  $urlkey: String
) {
  getCart(
    id: $id,
    urlkey: $urlkey
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    updatedAt
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "getCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerId": 4,
      "cartProducts": [CartProduct],
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "guestId": 4,
      "id": "4",
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": "4",
      "seller": User,
      "sellerId": 4,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}

getConnectRequest

Description

Retrieve single connect request by id

Response

Returns a ConnectRequest

Arguments
Name Description
id - ID

Example

Query
query GetConnectRequest($id: ID) {
  getConnectRequest(id: $id) {
    acceptedAt
    createdAt
    id
    rejectedAt
    requesterUser {
      ...UserFragment
    }
    source
    targetUser {
      ...UserFragment
    }
    term
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getConnectRequest": {
      "acceptedAt": "2007-12-03T10:15:30Z",
      "createdAt": "2007-12-03T10:15:30Z",
      "id": "4",
      "rejectedAt": "2007-12-03T10:15:30Z",
      "requesterUser": User,
      "source": "xyz789",
      "targetUser": User,
      "term": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

getContact

Description

Get a single Contact

Response

Returns a Contact

Arguments
Name Description
id - ID ID of the contact to retrieve
urlkey - String urlkey of the contact to retrieve

Example

Query
query GetContact(
  $id: ID,
  $urlkey: String
) {
  getContact(
    id: $id,
    urlkey: $urlkey
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "getContact": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "contactUser": User,
      "contactUserId": 4,
      "currency": "xyz789",
      "customId": "xyz789",
      "defaultSupplier": 123,
      "discount": 123.45,
      "email": "abc123",
      "id": 4,
      "img": ["abc123"],
      "invite": true,
      "invoiceAddress": "xyz789",
      "invoiceApartment": "abc123",
      "invoiceCity": "abc123",
      "invoiceCompany": "abc123",
      "invoiceCountry": "xyz789",
      "invoiceFirstname": "abc123",
      "invoiceLastname": "xyz789",
      "invoicePostalcode": "xyz789",
      "invoiceRegion": "abc123",
      "isSuperman": true,
      "isSuperwoman": false,
      "lastInvite": "2007-12-03T10:15:30Z",
      "migrateOldId": "abc123",
      "name": "xyz789",
      "notes": "abc123",
      "ownerId": 4,
      "paymentBankCustom": "xyz789",
      "paymentEmail": "abc123",
      "paymentIbanCustom": "xyz789",
      "paymentMethod": "xyz789",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "abc123",
      "phone": "abc123",
      "shippingAddress": "abc123",
      "shippingApartment": "abc123",
      "shippingCity": "xyz789",
      "shippingCompany": "xyz789",
      "shippingCountry": "xyz789",
      "shippingFirstname": "abc123",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "xyz789",
      "shippingRegion": "xyz789",
      "showConnectButton": false,
      "showPaymentTaxCode": false,
      "status": 987,
      "termOfPayment": "abc123",
      "type": 123,
      "urlkey": "xyz789"
    }
  }
}

getCredential

Description

Get credential for the user.

Response

Returns a Credential

Example

Query
query GetCredential {
  getCredential {
    accountType
    email
    isAdmin
    nlAccept
    plan {
      ...PlanFragment
    }
    recovery
    recoveryInform
    representing {
      ...UserFragment
    }
    status
    userId
    welcome
  }
}
Response
{
  "data": {
    "getCredential": {
      "accountType": "BUYER",
      "email": "xyz789",
      "isAdmin": false,
      "nlAccept": false,
      "plan": Plan,
      "recovery": "abc123",
      "recoveryInform": false,
      "representing": [User],
      "status": true,
      "userId": "4",
      "welcome": false
    }
  }
}

getDiscount

Description

get discount by id

Response

Returns a Discount

Arguments
Name Description
id - ID Discount id
urlkey - ID Non numerc uniq identifier of the Discount

Example

Query
query GetDiscount(
  $id: ID,
  $urlkey: ID
) {
  getDiscount(
    id: $id,
    urlkey: $urlkey
  ) {
    active
    applications
    fixedAmountValue
    id
    name
    ownerId
    percentageValue
    quantityOrAmount
    status
    type
    urlkey
    xgetyItems
    xgetyMinimumAmount
    xgetyMinimumQtyItems
    xgetyPercentage
  }
}
Variables
{"id": 4, "urlkey": "4"}
Response
{
  "data": {
    "getDiscount": {
      "active": true,
      "applications": 987,
      "fixedAmountValue": 123.45,
      "id": "4",
      "name": "abc123",
      "ownerId": 4,
      "percentageValue": 987.65,
      "quantityOrAmount": 123,
      "status": true,
      "type": 987,
      "urlkey": "4",
      "xgetyItems": "abc123",
      "xgetyMinimumAmount": 987.65,
      "xgetyMinimumQtyItems": 123.45,
      "xgetyPercentage": 123.45
    }
  }
}

getDiscounts

Use listDiscounts insptead
Description

get discounts

Response

Returns [Discount]

Arguments
Name Description
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
query - String filter discounts by name. Default = ""

Example

Query
query GetDiscounts(
  $first: Int,
  $offset: Int,
  $query: String
) {
  getDiscounts(
    first: $first,
    offset: $offset,
    query: $query
  ) {
    active
    applications
    fixedAmountValue
    id
    name
    ownerId
    percentageValue
    quantityOrAmount
    status
    type
    urlkey
    xgetyItems
    xgetyMinimumAmount
    xgetyMinimumQtyItems
    xgetyPercentage
  }
}
Variables
{"first": 25, "offset": 0, "query": ""}
Response
{
  "data": {
    "getDiscounts": [
      {
        "active": false,
        "applications": 987,
        "fixedAmountValue": 987.65,
        "id": "4",
        "name": "xyz789",
        "ownerId": "4",
        "percentageValue": 987.65,
        "quantityOrAmount": 123,
        "status": false,
        "type": 123,
        "urlkey": "4",
        "xgetyItems": "abc123",
        "xgetyMinimumAmount": 123.45,
        "xgetyMinimumQtyItems": 987.65,
        "xgetyPercentage": 987.65
      }
    ]
  }
}

getDrop

Description

Get single Drop by ID

Response

Returns a Drop

Arguments
Name Description
id - ID ID of the Drop
urlkey - String urlkey of the Drop

Example

Query
query GetDrop(
  $id: ID,
  $urlkey: String
) {
  getDrop(
    id: $id,
    urlkey: $urlkey
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "getDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 123,
      "archive": true,
      "asset": "abc123",
      "assets": ["abc123"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "abc123",
      "currencySell": "xyz789",
      "deadline": "2007-12-03T10:15:30Z",
      "deadlineStop": true,
      "deliveryEnd": "2007-12-03",
      "deliveryStart": "2007-12-03",
      "deliveryWindow": "abc123",
      "discounts": [Discount],
      "discoverable": true,
      "dropProducts": [DropProduct],
      "filter": 123,
      "filters": [987],
      "id": "4",
      "images": ["xyz789"],
      "img": "abc123",
      "info": "xyz789",
      "isPublic": false,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "note": "abc123",
      "openrate": 987,
      "order": 987,
      "orderItemsQty": 987.65,
      "orderQty": 987,
      "orderTotal": 987.65,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "xyz789",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "abc123",
      "products": [Product],
      "public": false,
      "publicVisitorCount": 987,
      "rangeDropInt": "abc123",
      "rangeDropText": "xyz789",
      "season": "xyz789",
      "status": 987,
      "supplier": Contact,
      "supplierName": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}

getDropProfile

Description

Retrieve user profile by a drop ID or urlkey

Response

Returns a User

Arguments
Name Description
id - ID ID of a drop owned by the user
urlkey - String urlkey of a drop owned by the user

Example

Query
query GetDropProfile(
  $id: ID,
  $urlkey: String
) {
  getDropProfile(
    id: $id,
    urlkey: $urlkey
  ) {
    canSearch
    contacts {
      ...ContactFragment
    }
    discoverable
    displayName
    emailProfile
    facebook
    id
    image
    imageMood
    images
    img
    imgMood
    info
    instagram
    name
    phone
    plans {
      ...UserPlanFragment
    }
    setting {
      ...SettingFragment
    }
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "getDropProfile": {
      "canSearch": true,
      "contacts": [Contact],
      "discoverable": false,
      "displayName": "abc123",
      "emailProfile": "abc123",
      "facebook": "abc123",
      "id": 4,
      "image": "xyz789",
      "imageMood": "abc123",
      "images": ["xyz789"],
      "img": ["xyz789"],
      "imgMood": ["abc123"],
      "info": "abc123",
      "instagram": "xyz789",
      "name": "abc123",
      "phone": "abc123",
      "plans": [UserPlan],
      "setting": Setting,
      "twitter": "xyz789",
      "url": "xyz789",
      "urlName": "abc123",
      "urlkey": "xyz789"
    }
  }
}

getDropRate

Response

Returns a DropRate

Arguments
Name Description
id - ID! ID of the Drop

Example

Query
query GetDropRate($id: ID!) {
  getDropRate(id: $id) {
    dropId
    rate
  }
}
Variables
{"id": "4"}
Response
{"data": {"getDropRate": {"dropId": 4, "rate": 987}}}

getEvent

Description

Get an event by id

Response

Returns an Event

Arguments
Name Description
id - ID! ID of the event to be fetched.

Example

Query
query GetEvent($id: ID!) {
  getEvent(id: $id) {
    id
    payload
    type
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getEvent": {
      "id": 4,
      "payload": Json,
      "type": "abc123"
    }
  }
}

getExternalContacts

use listExternalContacts instead
Description

get external contacts

Response

Returns [ExternalContact]

Arguments
Name Description
contactIds - [ID] contact ids

Example

Query
query GetExternalContacts($contactIds: [ID]) {
  getExternalContacts(contactIds: $contactIds) {
    contactId
    externalSystemId
    externalSystemName
    extra
    partnerIntegrationId
  }
}
Variables
{"contactIds": [4]}
Response
{
  "data": {
    "getExternalContacts": [
      {
        "contactId": "4",
        "externalSystemId": 4,
        "externalSystemName": "xyz789",
        "extra": "xyz789",
        "partnerIntegrationId": 4
      }
    ]
  }
}

getExternalOrders

use listExternalOrders instead
Description

get external order ids

Response

Returns [ExternalOrder]

Arguments
Name Description
orderIds - [ID] order ids

Example

Query
query GetExternalOrders($orderIds: [ID]) {
  getExternalOrders(orderIds: $orderIds) {
    externalSystemId
    externalSystemName
    extra
    orderId
    partnerIntegrationId
  }
}
Variables
{"orderIds": [4]}
Response
{
  "data": {
    "getExternalOrders": [
      {
        "externalSystemId": "4",
        "externalSystemName": "abc123",
        "extra": "xyz789",
        "orderId": "4",
        "partnerIntegrationId": 4
      }
    ]
  }
}

getExternalProducts

use listExternalProducts instead
Description

get external product ids

Response

Returns [ExternalProduct]

Arguments
Name Description
productIds - [ID] product ids

Example

Query
query GetExternalProducts($productIds: [ID]) {
  getExternalProducts(productIds: $productIds) {
    externalSystemId
    externalSystemName
    extra
    partnerIntegrationId
    productId
  }
}
Variables
{"productIds": ["4"]}
Response
{
  "data": {
    "getExternalProducts": [
      {
        "externalSystemId": "4",
        "externalSystemName": "abc123",
        "extra": "abc123",
        "partnerIntegrationId": 4,
        "productId": 4
      }
    ]
  }
}

getIntegration

Description

get integration

Response

Returns an Integration

Arguments
Name Description
userId - ID if nouser token is used this is required

Example

Query
query GetIntegration($userId: ID) {
  getIntegration(userId: $userId) {
    id
    ownerId
    shopifyAdminApiAccessToken
    shopifyApiSecretKey
    shopifyUrl
  }
}
Variables
{"userId": "4"}
Response
{
  "data": {
    "getIntegration": {
      "id": "4",
      "ownerId": 4,
      "shopifyAdminApiAccessToken": "xyz789",
      "shopifyApiSecretKey": "abc123",
      "shopifyUrl": "xyz789"
    }
  }
}

getIntegrationData

Description

get integration data

Response

Returns [IntegrationData]

Arguments
Name Description
fieldNames - [String] list of field names to get
userId - ID if nouser token is used this is required

Example

Query
query GetIntegrationData(
  $fieldNames: [String],
  $userId: ID
) {
  getIntegrationData(
    fieldNames: $fieldNames,
    userId: $userId
  ) {
    fieldName
    value
  }
}
Variables
{
  "fieldNames": ["xyz789"],
  "userId": "4"
}
Response
{
  "data": {
    "getIntegrationData": [
      {
        "fieldName": "abc123",
        "value": "abc123"
      }
    ]
  }
}

getIntegrationTokenByOrderId

Description

get integration by order id

Response

Returns an IntegrationData

Arguments
Name Description
orderId - ID

Example

Query
query GetIntegrationTokenByOrderId($orderId: ID) {
  getIntegrationTokenByOrderId(orderId: $orderId) {
    fieldName
    value
  }
}
Variables
{"orderId": 4}
Response
{
  "data": {
    "getIntegrationTokenByOrderId": {
      "fieldName": "abc123",
      "value": "xyz789"
    }
  }
}

getOrder

Description

Get an order by id or urlkey.

Response

Returns an Order

Arguments
Name Description
id - ID ID of the order
urlkey - String urlkey of the order

Example

Query
query GetOrder(
  $id: ID,
  $urlkey: String
) {
  getOrder(
    id: $id,
    urlkey: $urlkey
  ) {
    appliedDiscountId
    appliedPricelistId
    buyer {
      ...UserFragment
    }
    buyerId
    buyerName
    cancel
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceDate
    invoiceNo
    isSeller
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repId
    rows {
      ...OrderRowFragment
    }
    sellerId
    shippingCosts
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "getOrder": {
      "appliedDiscountId": 4,
      "appliedPricelistId": 4,
      "buyer": User,
      "buyerId": "4",
      "buyerName": "abc123",
      "cancel": false,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customDiscount": "abc123",
      "customId": "abc123",
      "discountAmount": 987.65,
      "discountType": "xyz789",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 123.45,
      "id": 4,
      "inform": false,
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": false,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": 4,
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 123.45,
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "abc123",
      "rating": 987,
      "rep": User,
      "repId": 4,
      "rows": [OrderRow],
      "sellerId": 4,
      "shippingCosts": 123.45,
      "status": true,
      "sumOfProducts": 987.65,
      "supplierName": "xyz789",
      "totalAmount": 123.45,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "vat": 123.45
    }
  }
}

getOrdersPricelistId

Description

Get order's (valid) pricelist_id

Response

Returns an OrderPricelist

Arguments
Name Description
orderId - ID order id

Example

Query
query GetOrdersPricelistId($orderId: ID) {
  getOrdersPricelistId(orderId: $orderId) {
    pricelistId
    valid
  }
}
Variables
{"orderId": "4"}
Response
{
  "data": {
    "getOrdersPricelistId": {
      "pricelistId": "4",
      "valid": false
    }
  }
}

getPartnerIntegration

Description

query for getting a partner integration

Response

Returns a PartnerIntegration

Arguments
Name Description
id - ID id of the partner integration

Example

Query
query GetPartnerIntegration($id: ID) {
  getPartnerIntegration(id: $id) {
    id
    listConfigurations {
      ...IntegrationConfigurationFragment
    }
    name
    owner {
      ...UserFragment
    }
    ownerId
    type
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getPartnerIntegration": {
      "id": 4,
      "listConfigurations": [IntegrationConfiguration],
      "name": "abc123",
      "owner": User,
      "ownerId": "4",
      "type": "xyz789"
    }
  }
}

getPaymentSubscription

Description

Get paymentSubscription.

Response

Returns a PaymentSubscription

Arguments
Name Description
id - ID

Example

Query
query GetPaymentSubscription($id: ID) {
  getPaymentSubscription(id: $id) {
    id
    stripeCustomerId
    stripeProductId
    stripeSubscriptionId
    stripeSubscriptionStatus
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getPaymentSubscription": {
      "id": "4",
      "stripeCustomerId": "abc123",
      "stripeProductId": "abc123",
      "stripeSubscriptionId": "xyz789",
      "stripeSubscriptionStatus": "xyz789"
    }
  }
}

getPlan

Description

get plan by id

Response

Returns a Plan

Arguments
Name Description
id - ID! Unique identifier of the object

Example

Query
query GetPlan($id: ID!) {
  getPlan(id: $id) {
    accountType
    description
    id
    name
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getPlan": {
      "accountType": "abc123",
      "description": "xyz789",
      "id": 4,
      "name": "xyz789"
    }
  }
}

getPricelist

Description

Retrieve single pricelist by id

Response

Returns a Pricelist

Arguments
Name Description
id - ID Unique identifier of a pricelist

Example

Query
query GetPricelist($id: ID) {
  getPricelist(id: $id) {
    _access {
      ..._PricelistAccessMetaFragment
    }
    _values {
      ..._PricelistValueMetaFragment
    }
    access {
      ...PricelistAccessFragment
    }
    currency
    drop {
      ...DropFragment
    }
    dropId
    dropName
    id
    name
    owner {
      ...UserFragment
    }
    ownerId
    status
    type
    urlkey
    values {
      ...PricelistValueFragment
    }
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getPricelist": {
      "_access": _PricelistAccessMeta,
      "_values": _PricelistValueMeta,
      "access": [PricelistAccess],
      "currency": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "dropName": "abc123",
      "id": 4,
      "name": "abc123",
      "owner": User,
      "ownerId": 4,
      "status": false,
      "type": 987,
      "urlkey": "xyz789",
      "values": [PricelistValue]
    }
  }
}

getPricelistValuesByPricelistId

Description

Get pricelist values by id

Response

Returns [PricelistValue]

Arguments
Name Description
pricelistId - ID!

Example

Query
query GetPricelistValuesByPricelistId($pricelistId: ID!) {
  getPricelistValuesByPricelistId(pricelistId: $pricelistId) {
    drop {
      ...DropFragment
    }
    dropId
    id
    ownerId
    price
    priceList
    pricelistId
    product {
      ...ProductFragment
    }
    productId
    rrp
    rrpList
  }
}
Variables
{"pricelistId": 4}
Response
{
  "data": {
    "getPricelistValuesByPricelistId": [
      {
        "drop": Drop,
        "dropId": "4",
        "id": "4",
        "ownerId": 4,
        "price": 123.45,
        "priceList": 123.45,
        "pricelistId": "4",
        "product": Product,
        "productId": 4,
        "rrp": "xyz789",
        "rrpList": "abc123"
      }
    ]
  }
}

getPricelists

listPricelists instead
Description

get pricelists

Response

Returns [Pricelist]

Arguments
Name Description
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
query - String filter pricelists by name. Default = ""

Example

Query
query GetPricelists(
  $first: Int,
  $offset: Int,
  $query: String
) {
  getPricelists(
    first: $first,
    offset: $offset,
    query: $query
  ) {
    _access {
      ..._PricelistAccessMetaFragment
    }
    _values {
      ..._PricelistValueMetaFragment
    }
    access {
      ...PricelistAccessFragment
    }
    currency
    drop {
      ...DropFragment
    }
    dropId
    dropName
    id
    name
    owner {
      ...UserFragment
    }
    ownerId
    status
    type
    urlkey
    values {
      ...PricelistValueFragment
    }
  }
}
Variables
{"first": 25, "offset": 0, "query": ""}
Response
{
  "data": {
    "getPricelists": [
      {
        "_access": _PricelistAccessMeta,
        "_values": _PricelistValueMeta,
        "access": [PricelistAccess],
        "currency": "abc123",
        "drop": Drop,
        "dropId": 4,
        "dropName": "xyz789",
        "id": 4,
        "name": "abc123",
        "owner": User,
        "ownerId": "4",
        "status": false,
        "type": 987,
        "urlkey": "abc123",
        "values": [PricelistValue]
      }
    ]
  }
}

getProduct

Description

Get a single product

Response

Returns a Product

Arguments
Name Description
id - ID Unique identifier of the entity
urlkey - String Unique non sequential identifier of the entity

Example

Query
query GetProduct(
  $id: ID,
  $urlkey: String
) {
  getProduct(
    id: $id,
    urlkey: $urlkey
  ) {
    color
    cost
    createdAt
    customField1
    customField2
    customField3
    customField4
    customField5
    customField6
    customField7
    customField8
    customId
    customIdInt
    customIdText
    ean
    externalProducts {
      ...ExternalProductFragment
    }
    id
    images
    img
    info
    inventoryStock
    inventoryStockLimit
    material
    name
    optionGroups {
      ...ProductOptionGroupFragment
    }
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    rangeProductInt
    rangeProductText
    rrp
    sku
    soldOut
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "getProduct": {
      "color": "abc123",
      "cost": 123.45,
      "createdAt": "2007-12-03T10:15:30Z",
      "customField1": "abc123",
      "customField2": "abc123",
      "customField3": "xyz789",
      "customField4": "abc123",
      "customField5": "xyz789",
      "customField6": "abc123",
      "customField7": "abc123",
      "customField8": "abc123",
      "customId": "abc123",
      "customIdInt": "xyz789",
      "customIdText": "abc123",
      "ean": "abc123",
      "externalProducts": [ExternalProduct],
      "id": "4",
      "images": ["abc123"],
      "img": "xyz789",
      "info": "abc123",
      "inventoryStock": "abc123",
      "inventoryStockLimit": "xyz789",
      "material": "abc123",
      "name": "xyz789",
      "optionGroups": [ProductOptionGroup],
      "optionValue1": "xyz789",
      "optionValue2": "abc123",
      "optionValue3": "abc123",
      "optionValue4": "abc123",
      "optionValue5": "xyz789",
      "origin": "xyz789",
      "owner": User,
      "ownerId": "xyz789",
      "parent": Product,
      "parentId": 4,
      "parentOrChild": "abc123",
      "price": 123.45,
      "rangeProductInt": "xyz789",
      "rangeProductText": "xyz789",
      "rrp": "abc123",
      "sku": "xyz789",
      "soldOut": false,
      "supplier": Contact,
      "supplierId": 4,
      "supplierName": "xyz789",
      "taric": "xyz789",
      "type": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "variants": [Product],
      "variantsV2": [ProductVariant]
    }
  }
}

getProductsByIds

Use listProducts instead
Description

Get a list of products by ids

Response

Returns [Product]

Arguments
Name Description
productIds - [ID] product ids

Example

Query
query GetProductsByIds($productIds: [ID]) {
  getProductsByIds(productIds: $productIds) {
    color
    cost
    createdAt
    customField1
    customField2
    customField3
    customField4
    customField5
    customField6
    customField7
    customField8
    customId
    customIdInt
    customIdText
    ean
    externalProducts {
      ...ExternalProductFragment
    }
    id
    images
    img
    info
    inventoryStock
    inventoryStockLimit
    material
    name
    optionGroups {
      ...ProductOptionGroupFragment
    }
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    rangeProductInt
    rangeProductText
    rrp
    sku
    soldOut
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"productIds": [4]}
Response
{
  "data": {
    "getProductsByIds": [
      {
        "color": "abc123",
        "cost": 987.65,
        "createdAt": "2007-12-03T10:15:30Z",
        "customField1": "xyz789",
        "customField2": "abc123",
        "customField3": "xyz789",
        "customField4": "xyz789",
        "customField5": "abc123",
        "customField6": "abc123",
        "customField7": "xyz789",
        "customField8": "abc123",
        "customId": "xyz789",
        "customIdInt": "xyz789",
        "customIdText": "xyz789",
        "ean": "abc123",
        "externalProducts": [ExternalProduct],
        "id": 4,
        "images": ["xyz789"],
        "img": "abc123",
        "info": "abc123",
        "inventoryStock": "xyz789",
        "inventoryStockLimit": "abc123",
        "material": "xyz789",
        "name": "abc123",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "abc123",
        "optionValue2": "xyz789",
        "optionValue3": "abc123",
        "optionValue4": "abc123",
        "optionValue5": "xyz789",
        "origin": "abc123",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "abc123",
        "price": 987.65,
        "rangeProductInt": "abc123",
        "rangeProductText": "abc123",
        "rrp": "xyz789",
        "sku": "xyz789",
        "soldOut": true,
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "xyz789",
        "taric": "xyz789",
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}

getProfile

Description

Get account info for the dashboard

Response

Returns a User

Arguments
Name Description
id - ID ID of the user to be retrieved
urlkey - String urlkey of the user to be retrieved

Example

Query
query GetProfile(
  $id: ID,
  $urlkey: String
) {
  getProfile(
    id: $id,
    urlkey: $urlkey
  ) {
    canSearch
    contacts {
      ...ContactFragment
    }
    discoverable
    displayName
    emailProfile
    facebook
    id
    image
    imageMood
    images
    img
    imgMood
    info
    instagram
    name
    phone
    plans {
      ...UserPlanFragment
    }
    setting {
      ...SettingFragment
    }
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "getProfile": {
      "canSearch": true,
      "contacts": [Contact],
      "discoverable": true,
      "displayName": "xyz789",
      "emailProfile": "xyz789",
      "facebook": "xyz789",
      "id": 4,
      "image": "abc123",
      "imageMood": "xyz789",
      "images": ["xyz789"],
      "img": ["xyz789"],
      "imgMood": ["xyz789"],
      "info": "abc123",
      "instagram": "abc123",
      "name": "abc123",
      "phone": "xyz789",
      "plans": [UserPlan],
      "setting": Setting,
      "twitter": "xyz789",
      "url": "abc123",
      "urlName": "abc123",
      "urlkey": "abc123"
    }
  }
}

getProfiles

To be removed without replacement
Description

Get user profiles

Response

Returns [User]

Example

Query
query GetProfiles {
  getProfiles {
    canSearch
    contacts {
      ...ContactFragment
    }
    discoverable
    displayName
    emailProfile
    facebook
    id
    image
    imageMood
    images
    img
    imgMood
    info
    instagram
    name
    phone
    plans {
      ...UserPlanFragment
    }
    setting {
      ...SettingFragment
    }
    twitter
    url
    urlName
    urlkey
  }
}
Response
{
  "data": {
    "getProfiles": [
      {
        "canSearch": false,
        "contacts": [Contact],
        "discoverable": true,
        "displayName": "abc123",
        "emailProfile": "xyz789",
        "facebook": "abc123",
        "id": "4",
        "image": "abc123",
        "imageMood": "abc123",
        "images": ["abc123"],
        "img": ["abc123"],
        "imgMood": ["abc123"],
        "info": "xyz789",
        "instagram": "xyz789",
        "name": "abc123",
        "phone": "abc123",
        "plans": [UserPlan],
        "setting": Setting,
        "twitter": "xyz789",
        "url": "xyz789",
        "urlName": "abc123",
        "urlkey": "abc123"
      }
    ]
  }
}

getSetting

Description

Get user settings

Response

Returns a Setting

Example

Query
query GetSetting {
  getSetting {
    addressAddress
    addressApartment
    addressCity
    addressCompany
    addressCountry
    addressFirstname
    addressLastname
    addressPostalcode
    country {
      ...CountryFragment
    }
    customAttach
    customField1Name
    customField1Status
    customField2Name
    customField2Status
    customField3Name
    customField3Status
    customField4Name
    customField4Status
    customField5Name
    customField5Status
    customField6Name
    customField6Status
    customField7Name
    customField7Status
    customField8Name
    customField8Status
    customHeight
    customInventory
    customInvite
    customInviteSubject
    customOption1Name
    customOption1Status
    customOption2Name
    customOption2Status
    customOption3Name
    customOption3Status
    customOption4Name
    customOption4Status
    customOption5Name
    customOption5Status
    customPreorder
    customSeperator
    customThankyou
    customUpdate
    customWidth
    fromCsv
    fromEmail
    fromMessage
    fromPdf
    fromSubject
    industries
    integrationToken {
      ...TokenFragment
    }
    integrationTokenId
    invoiceText
    ownerId
    paymentBank
    paymentIban
    paymentVat
    rangeDropInt
    rangeDropText
    rangeOrderInt
    rangeOrderText
    rangeProductInt
    rangeProductText
    rangeSupplierInt
    rangeSupplierText
    showInDashboard
  }
}
Response
{
  "data": {
    "getSetting": {
      "addressAddress": "abc123",
      "addressApartment": "xyz789",
      "addressCity": "abc123",
      "addressCompany": "abc123",
      "addressCountry": "xyz789",
      "addressFirstname": "xyz789",
      "addressLastname": "xyz789",
      "addressPostalcode": "xyz789",
      "country": Country,
      "customAttach": 123,
      "customField1Name": "abc123",
      "customField1Status": 987,
      "customField2Name": "xyz789",
      "customField2Status": 987,
      "customField3Name": "abc123",
      "customField3Status": 123,
      "customField4Name": "abc123",
      "customField4Status": 987,
      "customField5Name": "abc123",
      "customField5Status": 123,
      "customField6Name": "xyz789",
      "customField6Status": 987,
      "customField7Name": "xyz789",
      "customField7Status": 987,
      "customField8Name": "xyz789",
      "customField8Status": 987,
      "customHeight": "abc123",
      "customInventory": 987,
      "customInvite": "abc123",
      "customInviteSubject": "xyz789",
      "customOption1Name": "abc123",
      "customOption1Status": 123,
      "customOption2Name": "abc123",
      "customOption2Status": 987,
      "customOption3Name": "xyz789",
      "customOption3Status": 987,
      "customOption4Name": "xyz789",
      "customOption4Status": 987,
      "customOption5Name": "abc123",
      "customOption5Status": 123,
      "customPreorder": 123,
      "customSeperator": 987,
      "customThankyou": "xyz789",
      "customUpdate": "xyz789",
      "customWidth": "xyz789",
      "fromCsv": false,
      "fromEmail": "abc123",
      "fromMessage": "abc123",
      "fromPdf": true,
      "fromSubject": "abc123",
      "industries": ["abc123"],
      "integrationToken": Token,
      "integrationTokenId": "4",
      "invoiceText": "xyz789",
      "ownerId": "4",
      "paymentBank": "xyz789",
      "paymentIban": "xyz789",
      "paymentVat": "xyz789",
      "rangeDropInt": "xyz789",
      "rangeDropText": "abc123",
      "rangeOrderInt": "abc123",
      "rangeOrderText": "abc123",
      "rangeProductInt": "abc123",
      "rangeProductText": "xyz789",
      "rangeSupplierInt": "abc123",
      "rangeSupplierText": "abc123",
      "showInDashboard": true
    }
  }
}

listBrands

Description

list brands (filter by industry_id or brand_id)

Response

Returns [Brand]

Arguments
Name Description
filter - IndustryBrandFilter Filters to be applied on the industry_brand query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [BrandModelOrder] Options for sorting the results. Default = [CREATED_AT_DESC]

Example

Query
query ListBrands(
  $filter: IndustryBrandFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [BrandModelOrder]
) {
  listBrands(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    id
    name
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["CREATED_AT_DESC"]}
Response
{
  "data": {
    "listBrands": [
      {"id": 4, "name": "xyz789"}
    ]
  }
}

listCarts

Description

Get a list of carts

Response

Returns [Cart]

Arguments
Name Description
filter - CartFilter Filters to be applied to the carts query. Default = {}
first - Int Number of elements to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [CartModelOrder] Options for sorting the results. Default = [UPDATED_AT_DESC]

Example

Query
query ListCarts(
  $filter: CartFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [CartModelOrder]
) {
  listCarts(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listCarts": [
      {
        "_cartProductsMeta": CartProductsMeta,
        "_parentProductsMeta": CartProductsMeta,
        "buyer": User,
        "buyerId": "4",
        "cartProducts": [CartProduct],
        "createdAt": "2007-12-03T10:15:30Z",
        "creatorType": "xyz789",
        "drop": Drop,
        "dropId": 4,
        "guestId": 4,
        "id": "4",
        "isPrivate": true,
        "ownerId": "4",
        "parentProducts": [CartProduct],
        "repId": 4,
        "seller": User,
        "sellerId": 4,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123"
      }
    ]
  }
}

listConnectRequests

Description

Get a list of connect requests for current user

Response

Returns [ConnectRequest]

Arguments
Name Description
filter - ConnectRequestModelFilter Filters to be applied on the connect requests query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [ConnectRequestModelOrder] Options for sorting the results. Default = [ID_DESC]

Example

Query
query ListConnectRequests(
  $filter: ConnectRequestModelFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [ConnectRequestModelOrder]
) {
  listConnectRequests(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    acceptedAt
    createdAt
    id
    rejectedAt
    requesterUser {
      ...UserFragment
    }
    source
    targetUser {
      ...UserFragment
    }
    term
    updatedAt
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_DESC"]}
Response
{
  "data": {
    "listConnectRequests": [
      {
        "acceptedAt": "2007-12-03T10:15:30Z",
        "createdAt": "2007-12-03T10:15:30Z",
        "id": 4,
        "rejectedAt": "2007-12-03T10:15:30Z",
        "requesterUser": User,
        "source": "xyz789",
        "targetUser": User,
        "term": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

listContacts

Description

Get a list of contacts

Response

Returns [Contact]

Arguments
Name Description
filter - ContactFilter Conditions for filter contact results
first - Int Number of elements to retrieve, defaults to 100. Default = 100
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [ContactModelOrder] Options for sorting the results. Default = [ID_DESC]

Example

Query
query ListContacts(
  $filter: ContactFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [ContactModelOrder]
) {
  listContacts(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{
  "filter": ContactFilter,
  "first": 100,
  "offset": 0,
  "orderBy": ["ID_DESC"]
}
Response
{
  "data": {
    "listContacts": [
      {
        "accessCustomers": [AccessContact],
        "accessSuppliers": [AccessContact],
        "contactUser": User,
        "contactUserId": "4",
        "currency": "xyz789",
        "customId": "xyz789",
        "defaultSupplier": 123,
        "discount": 123.45,
        "email": "xyz789",
        "id": "4",
        "img": ["abc123"],
        "invite": true,
        "invoiceAddress": "abc123",
        "invoiceApartment": "abc123",
        "invoiceCity": "xyz789",
        "invoiceCompany": "abc123",
        "invoiceCountry": "xyz789",
        "invoiceFirstname": "abc123",
        "invoiceLastname": "xyz789",
        "invoicePostalcode": "abc123",
        "invoiceRegion": "xyz789",
        "isSuperman": false,
        "isSuperwoman": false,
        "lastInvite": "2007-12-03T10:15:30Z",
        "migrateOldId": "abc123",
        "name": "abc123",
        "notes": "abc123",
        "ownerId": 4,
        "paymentBankCustom": "abc123",
        "paymentEmail": "xyz789",
        "paymentIbanCustom": "abc123",
        "paymentMethod": "xyz789",
        "paymentTaxCode": "abc123",
        "paymentVatCustom": "xyz789",
        "phone": "abc123",
        "shippingAddress": "xyz789",
        "shippingApartment": "xyz789",
        "shippingCity": "xyz789",
        "shippingCompany": "xyz789",
        "shippingCountry": "xyz789",
        "shippingFirstname": "abc123",
        "shippingLastname": "abc123",
        "shippingPostalcode": "xyz789",
        "shippingRegion": "xyz789",
        "showConnectButton": true,
        "showPaymentTaxCode": true,
        "status": 987,
        "termOfPayment": "xyz789",
        "type": 987,
        "urlkey": "xyz789"
      }
    ]
  }
}

listContactsV2

Use listContacts instead - unctionality is identic
Description

Get a list of contacts

Response

Returns [Contact]

Arguments
Name Description
filter - ContactFilter Conditions for filter contact results
first - Int Number of elements to retrieve, defaults to 100. Default = 100
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [ContactModelOrder] Options for sorting the results. Default = [ID_DESC]

Example

Query
query ListContactsV2(
  $filter: ContactFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [ContactModelOrder]
) {
  listContactsV2(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{
  "filter": ContactFilter,
  "first": 100,
  "offset": 0,
  "orderBy": ["ID_DESC"]
}
Response
{
  "data": {
    "listContactsV2": [
      {
        "accessCustomers": [AccessContact],
        "accessSuppliers": [AccessContact],
        "contactUser": User,
        "contactUserId": "4",
        "currency": "abc123",
        "customId": "abc123",
        "defaultSupplier": 987,
        "discount": 987.65,
        "email": "abc123",
        "id": "4",
        "img": ["xyz789"],
        "invite": false,
        "invoiceAddress": "xyz789",
        "invoiceApartment": "xyz789",
        "invoiceCity": "xyz789",
        "invoiceCompany": "abc123",
        "invoiceCountry": "abc123",
        "invoiceFirstname": "xyz789",
        "invoiceLastname": "abc123",
        "invoicePostalcode": "xyz789",
        "invoiceRegion": "abc123",
        "isSuperman": false,
        "isSuperwoman": false,
        "lastInvite": "2007-12-03T10:15:30Z",
        "migrateOldId": "xyz789",
        "name": "abc123",
        "notes": "xyz789",
        "ownerId": 4,
        "paymentBankCustom": "abc123",
        "paymentEmail": "xyz789",
        "paymentIbanCustom": "xyz789",
        "paymentMethod": "abc123",
        "paymentTaxCode": "xyz789",
        "paymentVatCustom": "abc123",
        "phone": "xyz789",
        "shippingAddress": "xyz789",
        "shippingApartment": "xyz789",
        "shippingCity": "xyz789",
        "shippingCompany": "xyz789",
        "shippingCountry": "abc123",
        "shippingFirstname": "abc123",
        "shippingLastname": "xyz789",
        "shippingPostalcode": "abc123",
        "shippingRegion": "abc123",
        "showConnectButton": true,
        "showPaymentTaxCode": true,
        "status": 987,
        "termOfPayment": "abc123",
        "type": 123,
        "urlkey": "abc123"
      }
    ]
  }
}

listDiscounts

Description

List discounts with pagination and filtering

Response

Returns [Discount]

Arguments
Name Description
filter - DiscountFilter Filters to be applied to the discounts query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [DiscountModelOrder] Filters to be applied to the discounts query. Default = [ID_DESC]

Example

Query
query ListDiscounts(
  $filter: DiscountFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [DiscountModelOrder]
) {
  listDiscounts(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    active
    applications
    fixedAmountValue
    id
    name
    ownerId
    percentageValue
    quantityOrAmount
    status
    type
    urlkey
    xgetyItems
    xgetyMinimumAmount
    xgetyMinimumQtyItems
    xgetyPercentage
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_DESC"]}
Response
{
  "data": {
    "listDiscounts": [
      {
        "active": false,
        "applications": 987,
        "fixedAmountValue": 123.45,
        "id": "4",
        "name": "xyz789",
        "ownerId": 4,
        "percentageValue": 987.65,
        "quantityOrAmount": 123,
        "status": false,
        "type": 123,
        "urlkey": 4,
        "xgetyItems": "xyz789",
        "xgetyMinimumAmount": 987.65,
        "xgetyMinimumQtyItems": 987.65,
        "xgetyPercentage": 987.65
      }
    ]
  }
}

listDrops

Description

Retrieve list a paginated list of drops

Response

Returns [Drop]

Arguments
Name Description
filter - DropFilter Filters to be applied on the drops query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [DropModelOrder] Options for sorting the results. Default = [UPDATED_AT_DESC]

Example

Query
query ListDrops(
  $filter: DropFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [DropModelOrder]
) {
  listDrops(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 123,
        "archive": false,
        "asset": "abc123",
        "assets": ["abc123"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "xyz789",
        "currencySell": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "abc123",
        "discounts": [Discount],
        "discoverable": true,
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [987],
        "id": "4",
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "abc123",
        "isPublic": true,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "xyz789",
        "openrate": 123,
        "order": 987,
        "orderItemsQty": 987.65,
        "orderQty": 123,
        "orderTotal": 987.65,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "abc123",
        "products": [Product],
        "public": false,
        "publicVisitorCount": 987,
        "rangeDropInt": "abc123",
        "rangeDropText": "xyz789",
        "season": "abc123",
        "status": 123,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123"
      }
    ]
  }
}

listEvents

Description

Get a list of events

Response

Returns [Event]

Arguments
Name Description
filters - EventFilter Filters to be applied on the events query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [EventModelOrder] Options for sorting the results. Default = [UPDATED_AT_DESC]

Example

Query
query ListEvents(
  $filters: EventFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [EventModelOrder]
) {
  listEvents(
    filters: $filters,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    id
    payload
    type
  }
}
Variables
{"filters": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listEvents": [
      {
        "id": "4",
        "payload": Json,
        "type": "xyz789"
      }
    ]
  }
}

listExternalContacts

Response

Returns [ExternalContact]

Arguments
Name Description
filter - ExternalContactFilter filter
first - Int Number of elements to retrieve, defaults to 10. Default = 100
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ListExternalContacts(
  $filter: ExternalContactFilter,
  $first: Int,
  $offset: Int
) {
  listExternalContacts(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    contactId
    externalSystemId
    externalSystemName
    extra
    partnerIntegrationId
  }
}
Variables
{
  "filter": ExternalContactFilter,
  "first": 100,
  "offset": 0
}
Response
{
  "data": {
    "listExternalContacts": [
      {
        "contactId": "4",
        "externalSystemId": 4,
        "externalSystemName": "abc123",
        "extra": "abc123",
        "partnerIntegrationId": "4"
      }
    ]
  }
}

listExternalOrders

Response

Returns [ExternalOrder]

Arguments
Name Description
filter - ExternalOrderFilter filter
first - Int Number of elements to retrieve, defaults to 10. Default = 100
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ListExternalOrders(
  $filter: ExternalOrderFilter,
  $first: Int,
  $offset: Int
) {
  listExternalOrders(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    externalSystemId
    externalSystemName
    extra
    orderId
    partnerIntegrationId
  }
}
Variables
{"filter": ExternalOrderFilter, "first": 100, "offset": 0}
Response
{
  "data": {
    "listExternalOrders": [
      {
        "externalSystemId": 4,
        "externalSystemName": "abc123",
        "extra": "abc123",
        "orderId": "4",
        "partnerIntegrationId": 4
      }
    ]
  }
}

listExternalProducts

Response

Returns [ExternalProduct]

Arguments
Name Description
filter - ExternalProductFilter filter
first - Int Number of elements to retrieve, defaults to 10. Default = 100
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ListExternalProducts(
  $filter: ExternalProductFilter,
  $first: Int,
  $offset: Int
) {
  listExternalProducts(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    externalSystemId
    externalSystemName
    extra
    partnerIntegrationId
    productId
  }
}
Variables
{
  "filter": ExternalProductFilter,
  "first": 100,
  "offset": 0
}
Response
{
  "data": {
    "listExternalProducts": [
      {
        "externalSystemId": "4",
        "externalSystemName": "xyz789",
        "extra": "abc123",
        "partnerIntegrationId": 4,
        "productId": "4"
      }
    ]
  }
}

listIndustries

Description

Retrieve list a paginated list of industries

Response

Returns [Industry]

Arguments
Name Description
filter - IndustryFilter Filters to be applied on the industries query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [IndustryModelOrder] Options for sorting the results. Default = [ID_ASC]

Example

Query
query ListIndustries(
  $filter: IndustryFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [IndustryModelOrder]
) {
  listIndustries(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    id
    listBrands {
      ...BrandFragment
    }
    name
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listIndustries": [
      {
        "id": 4,
        "listBrands": [Brand],
        "name": "abc123"
      }
    ]
  }
}

listIntegrationConfigurations

Description

query for listing integration configurations

Response

Returns [IntegrationConfiguration]

Arguments
Name Description
filter - IntegrationConfigurationFilter Filters to be applied on the returned objects. Default = {}
first - Int Number of elements to retrieve, defaults to 100. Default = 100
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ListIntegrationConfigurations(
  $filter: IntegrationConfigurationFilter,
  $first: Int,
  $offset: Int
) {
  listIntegrationConfigurations(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    id
    key
    partnerIntegrationId
    value
  }
}
Variables
{"filter": {}, "first": 100, "offset": 0}
Response
{
  "data": {
    "listIntegrationConfigurations": [
      {
        "id": 4,
        "key": "xyz789",
        "partnerIntegrationId": 4,
        "value": "xyz789"
      }
    ]
  }
}

listNotifications

Description

Get a list of notifications

Response

Returns [Notification]

Arguments
Name Description
filter - NotificationFilter Filters to be applied to the notification query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ListNotifications(
  $filter: NotificationFilter,
  $first: Int,
  $offset: Int
) {
  listNotifications(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    createdAt
    id
    object {
      ... on ConnectRequest {
        ...ConnectRequestFragment
      }
    }
    payload
    seenAt
    type
    updatedAt
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0}
Response
{
  "data": {
    "listNotifications": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "id": 4,
        "object": ConnectRequest,
        "payload": "xyz789",
        "seenAt": "2007-12-03T10:15:30Z",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

listOrders

Response

Returns [Order]

Arguments
Name Description
filter - OrderFilter filtering options for orders. Default = {}
first - Int Number of elements to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [OrderingOptions] Options for sorting the results. Default = [ID_ASC]

Example

Query
query ListOrders(
  $filter: OrderFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [OrderingOptions]
) {
  listOrders(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    appliedDiscountId
    appliedPricelistId
    buyer {
      ...UserFragment
    }
    buyerId
    buyerName
    cancel
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceDate
    invoiceNo
    isSeller
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repId
    rows {
      ...OrderRowFragment
    }
    sellerId
    shippingCosts
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listOrders": [
      {
        "appliedDiscountId": 4,
        "appliedPricelistId": "4",
        "buyer": User,
        "buyerId": 4,
        "buyerName": "abc123",
        "cancel": true,
        "comment": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customDiscount": "abc123",
        "customId": "abc123",
        "discountAmount": 123.45,
        "discountType": "abc123",
        "drop": Drop,
        "dropId": "4",
        "extraCosts": 123.45,
        "id": "4",
        "inform": true,
        "invoiceDate": "2007-12-03",
        "invoiceNo": "xyz789",
        "isSeller": false,
        "orderExtraCosts": [OrderExtraCost],
        "orderMeta": OrderMeta,
        "orderTag": "xyz789",
        "owner": User,
        "ownerId": "4",
        "parentProducts": [OrderProduct],
        "products": [Product],
        "qty": 123.45,
        "rangeOrderInt": "xyz789",
        "rangeOrderText": "xyz789",
        "rating": 123,
        "rep": User,
        "repId": "4",
        "rows": [OrderRow],
        "sellerId": "4",
        "shippingCosts": 123.45,
        "status": true,
        "sumOfProducts": 987.65,
        "supplierName": "abc123",
        "totalAmount": 987.65,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "vat": 987.65
      }
    ]
  }
}

listPartnerIntegrations

Description

query for getting a list of partner integrations

Response

Returns [PartnerIntegration]

Arguments
Name Description
filter - PartnerIntegrationFilter filter for the partner integrations. Default = {}

Example

Query
query ListPartnerIntegrations($filter: PartnerIntegrationFilter) {
  listPartnerIntegrations(filter: $filter) {
    id
    listConfigurations {
      ...IntegrationConfigurationFragment
    }
    name
    owner {
      ...UserFragment
    }
    ownerId
    type
  }
}
Variables
{"filter": {}}
Response
{
  "data": {
    "listPartnerIntegrations": [
      {
        "id": 4,
        "listConfigurations": [IntegrationConfiguration],
        "name": "xyz789",
        "owner": User,
        "ownerId": 4,
        "type": "abc123"
      }
    ]
  }
}

listPartners

Description

Get a list of partner accounts

Response

Returns [User]

Arguments
Name Description
first - Int Number of elements to retrieve, defaults to 10. Default = 10
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query ListPartners(
  $first: Int,
  $offset: Int
) {
  listPartners(
    first: $first,
    offset: $offset
  ) {
    canSearch
    contacts {
      ...ContactFragment
    }
    discoverable
    displayName
    emailProfile
    facebook
    id
    image
    imageMood
    images
    img
    imgMood
    info
    instagram
    name
    phone
    plans {
      ...UserPlanFragment
    }
    setting {
      ...SettingFragment
    }
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{"first": 10, "offset": 0}
Response
{
  "data": {
    "listPartners": [
      {
        "canSearch": true,
        "contacts": [Contact],
        "discoverable": false,
        "displayName": "xyz789",
        "emailProfile": "xyz789",
        "facebook": "abc123",
        "id": 4,
        "image": "abc123",
        "imageMood": "abc123",
        "images": ["abc123"],
        "img": ["abc123"],
        "imgMood": ["abc123"],
        "info": "abc123",
        "instagram": "abc123",
        "name": "abc123",
        "phone": "abc123",
        "plans": [UserPlan],
        "setting": Setting,
        "twitter": "abc123",
        "url": "xyz789",
        "urlName": "abc123",
        "urlkey": "abc123"
      }
    ]
  }
}

listPaymentSubscriptions

Description

Retrieve list a paginated list of drops

Response

Returns [PaymentSubscription]

Arguments
Name Description
filter - PaymentSubscriptionFilter Filters to be applied on the drops query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [PaymentSubscriptionModelOrder] Options for sorting the results. Default = [ID_ASC]

Example

Query
query ListPaymentSubscriptions(
  $filter: PaymentSubscriptionFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [PaymentSubscriptionModelOrder]
) {
  listPaymentSubscriptions(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    id
    stripeCustomerId
    stripeProductId
    stripeSubscriptionId
    stripeSubscriptionStatus
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listPaymentSubscriptions": [
      {
        "id": "4",
        "stripeCustomerId": "xyz789",
        "stripeProductId": "abc123",
        "stripeSubscriptionId": "xyz789",
        "stripeSubscriptionStatus": "abc123"
      }
    ]
  }
}

listPlanChangeRequests

Description

List plan change requests

Response

Returns [PlanChangeRequest]

Arguments
Name Description
filter - PlanChangeRequestFilter Filters to be applied to the query results. Default = {acceptedAt: {exists: false}}
first - Int Number of elements to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [PlanChangeRequestModelOrder] Order to be applied to the query results. Default = [ID_DESC]

Example

Query
query ListPlanChangeRequests(
  $filter: PlanChangeRequestFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [PlanChangeRequestModelOrder]
) {
  listPlanChangeRequests(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    acceptedAt
    acceptedBy
    id
    plan {
      ...PlanFragment
    }
    planId
    userId
  }
}
Variables
{
  "filter": {"acceptedAt": {"exists": "false"}},
  "first": 25,
  "offset": 0,
  "orderBy": ["ID_DESC"]
}
Response
{
  "data": {
    "listPlanChangeRequests": [
      {
        "acceptedAt": "2007-12-03T10:15:30Z",
        "acceptedBy": 4,
        "id": "4",
        "plan": Plan,
        "planId": 4,
        "userId": 4
      }
    ]
  }
}

listPlans

Description

List plans with pagination and filtering

Response

Returns [Plan]

Arguments
Name Description
filter - PlanFilter Filters to be applied to the query results. Default = {}
first - Int Number of elements to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [PlanModelOrder] Order to be applied to the query results. Default = [ID_ASC]

Example

Query
query ListPlans(
  $filter: PlanFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [PlanModelOrder]
) {
  listPlans(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    accountType
    description
    id
    name
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listPlans": [
      {
        "accountType": "abc123",
        "description": "xyz789",
        "id": "4",
        "name": "xyz789"
      }
    ]
  }
}

listPricelists

Description

list pricelists

Response

Returns [Pricelist]

Arguments
Name Description
filter - PricelistFilter filtering options for orders. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [PricelistOrderingOptions] Options for sorting the results. Default = [ID_ASC]

Example

Query
query ListPricelists(
  $filter: PricelistFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [PricelistOrderingOptions]
) {
  listPricelists(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    _access {
      ..._PricelistAccessMetaFragment
    }
    _values {
      ..._PricelistValueMetaFragment
    }
    access {
      ...PricelistAccessFragment
    }
    currency
    drop {
      ...DropFragment
    }
    dropId
    dropName
    id
    name
    owner {
      ...UserFragment
    }
    ownerId
    status
    type
    urlkey
    values {
      ...PricelistValueFragment
    }
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listPricelists": [
      {
        "_access": _PricelistAccessMeta,
        "_values": _PricelistValueMeta,
        "access": [PricelistAccess],
        "currency": "abc123",
        "drop": Drop,
        "dropId": "4",
        "dropName": "abc123",
        "id": 4,
        "name": "xyz789",
        "owner": User,
        "ownerId": 4,
        "status": false,
        "type": 123,
        "urlkey": "abc123",
        "values": [PricelistValue]
      }
    ]
  }
}

listProducts

Description

Retrieve a list of products

Response

Returns [Product]

Arguments
Name Description
filter - ProductFilter Filters for the product list. Default = {}
first - Int Number of elements to retrieve, defaults to 10. Default = 10
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [ProductModelOrder] Options for sorting the results. Default = [ID_DESC]

Example

Query
query ListProducts(
  $filter: ProductFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [ProductModelOrder]
) {
  listProducts(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    color
    cost
    createdAt
    customField1
    customField2
    customField3
    customField4
    customField5
    customField6
    customField7
    customField8
    customId
    customIdInt
    customIdText
    ean
    externalProducts {
      ...ExternalProductFragment
    }
    id
    images
    img
    info
    inventoryStock
    inventoryStockLimit
    material
    name
    optionGroups {
      ...ProductOptionGroupFragment
    }
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    rangeProductInt
    rangeProductText
    rrp
    sku
    soldOut
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"filter": {}, "first": 10, "offset": 0, "orderBy": ["ID_DESC"]}
Response
{
  "data": {
    "listProducts": [
      {
        "color": "xyz789",
        "cost": 987.65,
        "createdAt": "2007-12-03T10:15:30Z",
        "customField1": "abc123",
        "customField2": "abc123",
        "customField3": "xyz789",
        "customField4": "xyz789",
        "customField5": "xyz789",
        "customField6": "xyz789",
        "customField7": "xyz789",
        "customField8": "abc123",
        "customId": "xyz789",
        "customIdInt": "abc123",
        "customIdText": "xyz789",
        "ean": "abc123",
        "externalProducts": [ExternalProduct],
        "id": 4,
        "images": ["abc123"],
        "img": "xyz789",
        "info": "xyz789",
        "inventoryStock": "abc123",
        "inventoryStockLimit": "abc123",
        "material": "abc123",
        "name": "xyz789",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "xyz789",
        "optionValue2": "xyz789",
        "optionValue3": "abc123",
        "optionValue4": "xyz789",
        "optionValue5": "xyz789",
        "origin": "xyz789",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": "4",
        "parentOrChild": "xyz789",
        "price": 123.45,
        "rangeProductInt": "abc123",
        "rangeProductText": "xyz789",
        "rrp": "abc123",
        "sku": "xyz789",
        "soldOut": true,
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "xyz789",
        "taric": "abc123",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}

listSharedDrops

Description

Retrieve list a paginated list of shared drops

Response

Returns [Drop]

Arguments
Name Description
filter - DropFilter Filters to be applied on the shared drops query. Default = {}
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [DropModelOrder] Options for sorting the results. Default = [UPDATED_AT_DESC]

Example

Query
query ListSharedDrops(
  $filter: DropFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [DropModelOrder]
) {
  listSharedDrops(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listSharedDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 987,
        "archive": false,
        "asset": "xyz789",
        "assets": ["abc123"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "abc123",
        "currencyBuy": "abc123",
        "currencySell": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "abc123",
        "discounts": [Discount],
        "discoverable": true,
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [123],
        "id": 4,
        "images": ["abc123"],
        "img": "xyz789",
        "info": "xyz789",
        "isPublic": false,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "xyz789",
        "note": "xyz789",
        "openrate": 123,
        "order": 987,
        "orderItemsQty": 123.45,
        "orderQty": 987,
        "orderTotal": 123.45,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "products": [Product],
        "public": false,
        "publicVisitorCount": 123,
        "rangeDropInt": "xyz789",
        "rangeDropText": "abc123",
        "season": "xyz789",
        "status": 123,
        "supplier": Contact,
        "supplierName": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}

listSystemCurrencyCodes

Description

Retrive a list of 3 character currency codes used by the order41 system

Response

Returns [String]

Example

Query
query ListSystemCurrencyCodes {
  listSystemCurrencyCodes
}
Response
{
  "data": {
    "listSystemCurrencyCodes": ["xyz789"]
  }
}

listTeamUsers

Description

List teamUsers

Response

Returns [TeamUser]

Arguments
Name Description
first - Int Number of elemts to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderBy - [TeamUserModelOrder] Options for sorting the results. Default = [ID_ASC]

Example

Query
query ListTeamUsers(
  $first: Int,
  $offset: Int,
  $orderBy: [TeamUserModelOrder]
) {
  listTeamUsers(
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listTeamUsers": [
      {
        "credential": Cred,
        "credentialId": "4",
        "id": 4,
        "role": "xyz789",
        "userId": "4"
      }
    ]
  }
}

listWebhooks

Description

webhoook queries

Response

Returns [Webhook]

Example

Query
query ListWebhooks {
  listWebhooks {
    headers
    id
    owner {
      ...UserFragment
    }
    ownerId
    password
    url
    userName
    webhookEvents {
      ...WebhookEventFragment
    }
  }
}
Response
{
  "data": {
    "listWebhooks": [
      {
        "headers": Json,
        "id": "4",
        "owner": User,
        "ownerId": "4",
        "password": "abc123",
        "url": "abc123",
        "userName": "xyz789",
        "webhookEvents": [WebhookEvent]
      }
    ]
  }
}

listWorkspaces

Response

Returns [User]

Example

Query
query ListWorkspaces {
  listWorkspaces {
    canSearch
    contacts {
      ...ContactFragment
    }
    discoverable
    displayName
    emailProfile
    facebook
    id
    image
    imageMood
    images
    img
    imgMood
    info
    instagram
    name
    phone
    plans {
      ...UserPlanFragment
    }
    setting {
      ...SettingFragment
    }
    twitter
    url
    urlName
    urlkey
  }
}
Response
{
  "data": {
    "listWorkspaces": [
      {
        "canSearch": false,
        "contacts": [Contact],
        "discoverable": false,
        "displayName": "xyz789",
        "emailProfile": "abc123",
        "facebook": "xyz789",
        "id": "4",
        "image": "abc123",
        "imageMood": "abc123",
        "images": ["xyz789"],
        "img": ["xyz789"],
        "imgMood": ["xyz789"],
        "info": "xyz789",
        "instagram": "xyz789",
        "name": "xyz789",
        "phone": "xyz789",
        "plans": [UserPlan],
        "setting": Setting,
        "twitter": "abc123",
        "url": "abc123",
        "urlName": "xyz789",
        "urlkey": "abc123"
      }
    ]
  }
}

orderStatistics

Description

Get statistical data for a list of orders.

Response

Returns an OrderStatistics

Arguments
Name Description
filter - OrderFilter filtering options for orders. Default = {}

Example

Query
query OrderStatistics($filter: OrderFilter) {
  orderStatistics(filter: $filter) {
    amountBySupplier {
      ...AmountBySupplierFragment
    }
    totalAmount
    totalOrderedItems
  }
}
Variables
{"filter": {}}
Response
{
  "data": {
    "orderStatistics": {
      "amountBySupplier": [AmountBySupplier],
      "totalAmount": 123.45,
      "totalOrderedItems": 123.45
    }
  }
}

orders

Use listOrders instead
Description

Get a list of orders

Response

Returns [Order]

Arguments
Name Description
first - Int Number of elements to retrieve, defaults to 25. Default = 25
offset - Int Number of first elements to be left out, defaults to 0. Default = 0
orderFilter - OrderFilter filtering options for orders. Default = {}

Example

Query
query Orders(
  $first: Int,
  $offset: Int,
  $orderFilter: OrderFilter
) {
  orders(
    first: $first,
    offset: $offset,
    orderFilter: $orderFilter
  ) {
    appliedDiscountId
    appliedPricelistId
    buyer {
      ...UserFragment
    }
    buyerId
    buyerName
    cancel
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceDate
    invoiceNo
    isSeller
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repId
    rows {
      ...OrderRowFragment
    }
    sellerId
    shippingCosts
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"first": 25, "offset": 0, "orderFilter": {}}
Response
{
  "data": {
    "orders": [
      {
        "appliedDiscountId": 4,
        "appliedPricelistId": "4",
        "buyer": User,
        "buyerId": "4",
        "buyerName": "xyz789",
        "cancel": true,
        "comment": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "customDiscount": "abc123",
        "customId": "abc123",
        "discountAmount": 987.65,
        "discountType": "abc123",
        "drop": Drop,
        "dropId": "4",
        "extraCosts": 123.45,
        "id": 4,
        "inform": true,
        "invoiceDate": "2007-12-03",
        "invoiceNo": "xyz789",
        "isSeller": false,
        "orderExtraCosts": [OrderExtraCost],
        "orderMeta": OrderMeta,
        "orderTag": "abc123",
        "owner": User,
        "ownerId": 4,
        "parentProducts": [OrderProduct],
        "products": [Product],
        "qty": 987.65,
        "rangeOrderInt": "xyz789",
        "rangeOrderText": "abc123",
        "rating": 987,
        "rep": User,
        "repId": 4,
        "rows": [OrderRow],
        "sellerId": 4,
        "shippingCosts": 987.65,
        "status": false,
        "sumOfProducts": 123.45,
        "supplierName": "abc123",
        "totalAmount": 123.45,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "vat": 123.45
      }
    ]
  }
}

ordersByIds

Description

Get a list of orders by ids

Response

Returns [Order]

Arguments
Name Description
orderIds - [ID] order ids

Example

Query
query OrdersByIds($orderIds: [ID]) {
  ordersByIds(orderIds: $orderIds) {
    appliedDiscountId
    appliedPricelistId
    buyer {
      ...UserFragment
    }
    buyerId
    buyerName
    cancel
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceDate
    invoiceNo
    isSeller
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repId
    rows {
      ...OrderRowFragment
    }
    sellerId
    shippingCosts
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"orderIds": [4]}
Response
{
  "data": {
    "ordersByIds": [
      {
        "appliedDiscountId": "4",
        "appliedPricelistId": "4",
        "buyer": User,
        "buyerId": "4",
        "buyerName": "abc123",
        "cancel": false,
        "comment": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customDiscount": "xyz789",
        "customId": "xyz789",
        "discountAmount": 123.45,
        "discountType": "abc123",
        "drop": Drop,
        "dropId": "4",
        "extraCosts": 987.65,
        "id": 4,
        "inform": false,
        "invoiceDate": "2007-12-03",
        "invoiceNo": "abc123",
        "isSeller": false,
        "orderExtraCosts": [OrderExtraCost],
        "orderMeta": OrderMeta,
        "orderTag": "xyz789",
        "owner": User,
        "ownerId": 4,
        "parentProducts": [OrderProduct],
        "products": [Product],
        "qty": 123.45,
        "rangeOrderInt": "xyz789",
        "rangeOrderText": "xyz789",
        "rating": 987,
        "rep": User,
        "repId": "4",
        "rows": [OrderRow],
        "sellerId": "4",
        "shippingCosts": 987.65,
        "status": true,
        "sumOfProducts": 987.65,
        "supplierName": "xyz789",
        "totalAmount": 987.65,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "vat": 987.65
      }
    ]
  }
}

products

Use listProducts instead
Description

Get a list of products

Response

Returns [Product]

Arguments
Name Description
first - Int Number of elements to retrieve, defaults to 10. Default = 10
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query Products(
  $first: Int,
  $offset: Int
) {
  products(
    first: $first,
    offset: $offset
  ) {
    color
    cost
    createdAt
    customField1
    customField2
    customField3
    customField4
    customField5
    customField6
    customField7
    customField8
    customId
    customIdInt
    customIdText
    ean
    externalProducts {
      ...ExternalProductFragment
    }
    id
    images
    img
    info
    inventoryStock
    inventoryStockLimit
    material
    name
    optionGroups {
      ...ProductOptionGroupFragment
    }
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    rangeProductInt
    rangeProductText
    rrp
    sku
    soldOut
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"first": 10, "offset": 0}
Response
{
  "data": {
    "products": [
      {
        "color": "xyz789",
        "cost": 987.65,
        "createdAt": "2007-12-03T10:15:30Z",
        "customField1": "abc123",
        "customField2": "xyz789",
        "customField3": "abc123",
        "customField4": "xyz789",
        "customField5": "abc123",
        "customField6": "abc123",
        "customField7": "xyz789",
        "customField8": "xyz789",
        "customId": "abc123",
        "customIdInt": "xyz789",
        "customIdText": "abc123",
        "ean": "xyz789",
        "externalProducts": [ExternalProduct],
        "id": 4,
        "images": ["abc123"],
        "img": "abc123",
        "info": "abc123",
        "inventoryStock": "xyz789",
        "inventoryStockLimit": "xyz789",
        "material": "abc123",
        "name": "xyz789",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "xyz789",
        "optionValue2": "abc123",
        "optionValue3": "abc123",
        "optionValue4": "abc123",
        "optionValue5": "abc123",
        "origin": "abc123",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "xyz789",
        "price": 987.65,
        "rangeProductInt": "abc123",
        "rangeProductText": "abc123",
        "rrp": "abc123",
        "sku": "abc123",
        "soldOut": true,
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "abc123",
        "taric": "abc123",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}

recentDrops

Description

Get a list of recent drops from own network

Response

Returns [Drop]

Arguments
Name Description
first - Int Number of elemts to retrieve, defaults to 3. Default = 3
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query RecentDrops(
  $first: Int,
  $offset: Int
) {
  recentDrops(
    first: $first,
    offset: $offset
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"first": 3, "offset": 0}
Response
{
  "data": {
    "recentDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 987,
        "archive": true,
        "asset": "abc123",
        "assets": ["abc123"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "abc123",
        "currencyBuy": "abc123",
        "currencySell": "abc123",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "xyz789",
        "discounts": [Discount],
        "discoverable": false,
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [123],
        "id": 4,
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "abc123",
        "isPublic": false,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "abc123",
        "openrate": 123,
        "order": 123,
        "orderItemsQty": 123.45,
        "orderQty": 123,
        "orderTotal": 123.45,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "products": [Product],
        "public": false,
        "publicVisitorCount": 987,
        "rangeDropInt": "xyz789",
        "rangeDropText": "abc123",
        "season": "xyz789",
        "status": 123,
        "supplier": Contact,
        "supplierName": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123"
      }
    ]
  }
}

searchSellerProfiles

Description

Search/query seller profiles.

Response

Returns [User]

Arguments
Name Description
query - String Query seller profiles by name.

Example

Query
query SearchSellerProfiles($query: String) {
  searchSellerProfiles(query: $query) {
    canSearch
    contacts {
      ...ContactFragment
    }
    discoverable
    displayName
    emailProfile
    facebook
    id
    image
    imageMood
    images
    img
    imgMood
    info
    instagram
    name
    phone
    plans {
      ...UserPlanFragment
    }
    setting {
      ...SettingFragment
    }
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{"query": "abc123"}
Response
{
  "data": {
    "searchSellerProfiles": [
      {
        "canSearch": false,
        "contacts": [Contact],
        "discoverable": true,
        "displayName": "xyz789",
        "emailProfile": "xyz789",
        "facebook": "xyz789",
        "id": 4,
        "image": "abc123",
        "imageMood": "abc123",
        "images": ["xyz789"],
        "img": ["xyz789"],
        "imgMood": ["xyz789"],
        "info": "abc123",
        "instagram": "xyz789",
        "name": "abc123",
        "phone": "abc123",
        "plans": [UserPlan],
        "setting": Setting,
        "twitter": "xyz789",
        "url": "xyz789",
        "urlName": "xyz789",
        "urlkey": "abc123"
      }
    ]
  }
}

userProducts

Use listProducts instead
Description

Get a list of products

Response

Returns [UserProduct]

Arguments
Name Description
first - Int Number of elements to retrieve, defaults to 10. Default = 10
offset - Int Number of first elements to be left out, defaults to 0. Default = 0

Example

Query
query UserProducts(
  $first: Int,
  $offset: Int
) {
  userProducts(
    first: $first,
    offset: $offset
  ) {
    color
    cost
    createdAt
    customField1
    customField2
    customField3
    customField4
    customField5
    customField6
    customField7
    customField8
    customId
    customIdInt
    customIdText
    ean
    externalProducts {
      ...ExternalProductFragment
    }
    id
    images
    img
    info
    inventoryStock
    inventoryStockLimit
    material
    name
    optionGroups {
      ...ProductOptionGroupFragment
    }
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    rangeProductInt
    rangeProductText
    rrp
    sku
    soldOut
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"first": 10, "offset": 0}
Response
{
  "data": {
    "userProducts": [
      {
        "color": "xyz789",
        "cost": 987.65,
        "createdAt": "2007-12-03T10:15:30Z",
        "customField1": "xyz789",
        "customField2": "xyz789",
        "customField3": "xyz789",
        "customField4": "xyz789",
        "customField5": "xyz789",
        "customField6": "abc123",
        "customField7": "xyz789",
        "customField8": "abc123",
        "customId": "abc123",
        "customIdInt": "xyz789",
        "customIdText": "abc123",
        "ean": "abc123",
        "externalProducts": [ExternalProduct],
        "id": "4",
        "images": ["xyz789"],
        "img": ["xyz789"],
        "info": "abc123",
        "inventoryStock": "abc123",
        "inventoryStockLimit": "xyz789",
        "material": "xyz789",
        "name": "xyz789",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "xyz789",
        "optionValue2": "abc123",
        "optionValue3": "abc123",
        "optionValue4": "abc123",
        "optionValue5": "abc123",
        "origin": "abc123",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "xyz789",
        "price": 987.65,
        "rangeProductInt": "abc123",
        "rangeProductText": "xyz789",
        "rrp": "xyz789",
        "sku": "xyz789",
        "soldOut": false,
        "supplier": Contact,
        "supplierId": 4,
        "supplierName": "abc123",
        "taric": "xyz789",
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}

Mutations

acceptConnectRequest

Description

Accept a connect request

Response

Returns a ConnectRequest

Arguments
Name Description
id - ID

Example

Query
mutation AcceptConnectRequest($id: ID) {
  acceptConnectRequest(id: $id) {
    acceptedAt
    createdAt
    id
    rejectedAt
    requesterUser {
      ...UserFragment
    }
    source
    targetUser {
      ...UserFragment
    }
    term
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "acceptConnectRequest": {
      "acceptedAt": "2007-12-03T10:15:30Z",
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 4,
      "rejectedAt": "2007-12-03T10:15:30Z",
      "requesterUser": User,
      "source": "abc123",
      "targetUser": User,
      "term": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

addAccessCustomers

Description

Add accessCustomers.

Response

Returns a Contact

Arguments
Name Description
customerIds - [ID] Ids of customer contacts
id - ID! Id of the contact to which access_customers will be added.

Example

Query
mutation AddAccessCustomers(
  $customerIds: [ID],
  $id: ID!
) {
  addAccessCustomers(
    customerIds: $customerIds,
    id: $id
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{
  "customerIds": ["4"],
  "id": "4"
}
Response
{
  "data": {
    "addAccessCustomers": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "contactUser": User,
      "contactUserId": 4,
      "currency": "abc123",
      "customId": "xyz789",
      "defaultSupplier": 123,
      "discount": 987.65,
      "email": "xyz789",
      "id": "4",
      "img": ["abc123"],
      "invite": true,
      "invoiceAddress": "abc123",
      "invoiceApartment": "xyz789",
      "invoiceCity": "xyz789",
      "invoiceCompany": "abc123",
      "invoiceCountry": "xyz789",
      "invoiceFirstname": "xyz789",
      "invoiceLastname": "abc123",
      "invoicePostalcode": "abc123",
      "invoiceRegion": "xyz789",
      "isSuperman": false,
      "isSuperwoman": true,
      "lastInvite": "2007-12-03T10:15:30Z",
      "migrateOldId": "xyz789",
      "name": "abc123",
      "notes": "xyz789",
      "ownerId": "4",
      "paymentBankCustom": "xyz789",
      "paymentEmail": "xyz789",
      "paymentIbanCustom": "xyz789",
      "paymentMethod": "abc123",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "abc123",
      "phone": "xyz789",
      "shippingAddress": "abc123",
      "shippingApartment": "abc123",
      "shippingCity": "xyz789",
      "shippingCompany": "xyz789",
      "shippingCountry": "xyz789",
      "shippingFirstname": "abc123",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "abc123",
      "shippingRegion": "xyz789",
      "showConnectButton": false,
      "showPaymentTaxCode": false,
      "status": 987,
      "termOfPayment": "abc123",
      "type": 123,
      "urlkey": "xyz789"
    }
  }
}

addAccessSuppliers

Description

Add accessSuppliers.

Response

Returns a Contact

Arguments
Name Description
id - ID! Id of the contact to which access_suppliers will be added.
supplierIds - [ID] Ids of the suppliers.

Example

Query
mutation AddAccessSuppliers(
  $id: ID!,
  $supplierIds: [ID]
) {
  addAccessSuppliers(
    id: $id,
    supplierIds: $supplierIds
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{
  "id": "4",
  "supplierIds": ["4"]
}
Response
{
  "data": {
    "addAccessSuppliers": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "contactUser": User,
      "contactUserId": "4",
      "currency": "abc123",
      "customId": "abc123",
      "defaultSupplier": 987,
      "discount": 123.45,
      "email": "abc123",
      "id": "4",
      "img": ["xyz789"],
      "invite": false,
      "invoiceAddress": "abc123",
      "invoiceApartment": "abc123",
      "invoiceCity": "abc123",
      "invoiceCompany": "abc123",
      "invoiceCountry": "abc123",
      "invoiceFirstname": "xyz789",
      "invoiceLastname": "abc123",
      "invoicePostalcode": "xyz789",
      "invoiceRegion": "xyz789",
      "isSuperman": true,
      "isSuperwoman": false,
      "lastInvite": "2007-12-03T10:15:30Z",
      "migrateOldId": "abc123",
      "name": "xyz789",
      "notes": "xyz789",
      "ownerId": 4,
      "paymentBankCustom": "abc123",
      "paymentEmail": "xyz789",
      "paymentIbanCustom": "xyz789",
      "paymentMethod": "abc123",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "abc123",
      "phone": "abc123",
      "shippingAddress": "xyz789",
      "shippingApartment": "xyz789",
      "shippingCity": "abc123",
      "shippingCompany": "abc123",
      "shippingCountry": "abc123",
      "shippingFirstname": "xyz789",
      "shippingLastname": "abc123",
      "shippingPostalcode": "abc123",
      "shippingRegion": "abc123",
      "showConnectButton": true,
      "showPaymentTaxCode": true,
      "status": 987,
      "termOfPayment": "abc123",
      "type": 123,
      "urlkey": "abc123"
    }
  }
}

addDiscount

Description

Add a discount to the drop

Response

Returns a DropDiscount

Arguments
Name Description
discountId - ID! Id of the discount
dropId - ID! Id of the drop

Example

Query
mutation AddDiscount(
  $discountId: ID!,
  $dropId: ID!
) {
  addDiscount(
    discountId: $discountId,
    dropId: $dropId
  ) {
    discount {
      ...DiscountFragment
    }
    drop {
      ...DropFragment
    }
    id
  }
}
Variables
{
  "discountId": "4",
  "dropId": "4"
}
Response
{
  "data": {
    "addDiscount": {
      "discount": Discount,
      "drop": Drop,
      "id": "4"
    }
  }
}

addProductToOrder

Response

Returns an Order

Arguments
Name Description
id - ID id of the drop
productId - ID product id
quantity - Float quantity of the order product
urlkey - String urlkey of the order

Example

Query
mutation AddProductToOrder(
  $id: ID,
  $productId: ID,
  $quantity: Float,
  $urlkey: String
) {
  addProductToOrder(
    id: $id,
    productId: $productId,
    quantity: $quantity,
    urlkey: $urlkey
  ) {
    appliedDiscountId
    appliedPricelistId
    buyer {
      ...UserFragment
    }
    buyerId
    buyerName
    cancel
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceDate
    invoiceNo
    isSeller
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repId
    rows {
      ...OrderRowFragment
    }
    sellerId
    shippingCosts
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{
  "id": 4,
  "productId": "4",
  "quantity": 123.45,
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "addProductToOrder": {
      "appliedDiscountId": "4",
      "appliedPricelistId": 4,
      "buyer": User,
      "buyerId": 4,
      "buyerName": "abc123",
      "cancel": true,
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customDiscount": "xyz789",
      "customId": "xyz789",
      "discountAmount": 123.45,
      "discountType": "xyz789",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 987.65,
      "id": 4,
      "inform": true,
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": false,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": "4",
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 987.65,
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "xyz789",
      "rating": 123,
      "rep": User,
      "repId": 4,
      "rows": [OrderRow],
      "sellerId": 4,
      "shippingCosts": 987.65,
      "status": true,
      "sumOfProducts": 987.65,
      "supplierName": "abc123",
      "totalAmount": 123.45,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "vat": 987.65
    }
  }
}

addProductsToDrop

Response

Returns an Int

Arguments
Name Description
dropId - ID ID of the Drop
productIds - [ID] product_ids that will be added to the drop

Example

Query
mutation AddProductsToDrop(
  $dropId: ID,
  $productIds: [ID]
) {
  addProductsToDrop(
    dropId: $dropId,
    productIds: $productIds
  )
}
Variables
{"dropId": 4, "productIds": ["4"]}
Response
{"data": {"addProductsToDrop": 987}}

addTeamUser

Description

Add teamUser

Response

Returns a TeamUser

Arguments
Name Description
email - String
role - TeamRoleType Default = ADMIN

Example

Query
mutation AddTeamUser(
  $email: String,
  $role: TeamRoleType
) {
  addTeamUser(
    email: $email,
    role: $role
  ) {
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"email": "abc123", "role": "ADMIN"}
Response
{
  "data": {
    "addTeamUser": {
      "credential": Cred,
      "credentialId": 4,
      "id": "4",
      "role": "abc123",
      "userId": 4
    }
  }
}

addToCart

Description

Add products to an existing or new cart

Response

Returns a Cart

Arguments
Name Description
cartProduct - AddToCartInput
input - AddToCartInput

Example

Query
mutation AddToCart(
  $cartProduct: AddToCartInput,
  $input: AddToCartInput
) {
  addToCart(
    cartProduct: $cartProduct,
    input: $input
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    updatedAt
    urlkey
  }
}
Variables
{
  "cartProduct": AddToCartInput,
  "input": AddToCartInput
}
Response
{
  "data": {
    "addToCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerId": "4",
      "cartProducts": [CartProduct],
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": "4",
      "guestId": 4,
      "id": 4,
      "isPrivate": false,
      "ownerId": "4",
      "parentProducts": [CartProduct],
      "repId": 4,
      "seller": User,
      "sellerId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}

addWebhookEvents

Response

Returns an Int

Arguments
Name Description
webhookEvents - [WebhookEventInput] webhook events
webhookId - ID! webhook id

Example

Query
mutation AddWebhookEvents(
  $webhookEvents: [WebhookEventInput],
  $webhookId: ID!
) {
  addWebhookEvents(
    webhookEvents: $webhookEvents,
    webhookId: $webhookId
  )
}
Variables
{
  "webhookEvents": [WebhookEventInput],
  "webhookId": "4"
}
Response
{"data": {"addWebhookEvents": 123}}

autoGenerateCart

Description

Generates a sugestion for a cart

Response

Returns a Cart

Arguments
Name Description
buyerId - ID Defaults to current user
dropId - ID! Drop id from which to take the product for the new cart

Example

Query
mutation AutoGenerateCart(
  $buyerId: ID,
  $dropId: ID!
) {
  autoGenerateCart(
    buyerId: $buyerId,
    dropId: $dropId
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    updatedAt
    urlkey
  }
}
Variables
{"buyerId": "4", "dropId": 4}
Response
{
  "data": {
    "autoGenerateCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerId": "4",
      "cartProducts": [CartProduct],
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "guestId": 4,
      "id": 4,
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": "4",
      "seller": User,
      "sellerId": 4,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}

bulkProductImportSampleFile

Description

Bulk product import sample file.

Response

Returns an Url

Example

Query
mutation BulkProductImportSampleFile {
  bulkProductImportSampleFile {
    url
  }
}
Response
{
  "data": {
    "bulkProductImportSampleFile": {
      "url": "xyz789"
    }
  }
}

copyDemoAccount

Description

Copy a user account

Response

Returns a BackgroundJob

Arguments
Name Description
email - String! Email of the new user
urlkey - String! urlkey of the demo account to copy

Example

Query
mutation CopyDemoAccount(
  $email: String!,
  $urlkey: String!
) {
  copyDemoAccount(
    email: $email,
    urlkey: $urlkey
  ) {
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "email": "abc123",
  "urlkey": "abc123"
}
Response
{
  "data": {
    "copyDemoAccount": {
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": "4",
      "orderId": "4",
      "result": "xyz789",
      "type": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

copyDrop

Description

starts the bg job for copying a drop returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
dropUrlkey - String! urlkey of the Drop
targetUserUrlkey - String! urlkey of the target user

Example

Query
mutation CopyDrop(
  $dropUrlkey: String!,
  $targetUserUrlkey: String!
) {
  copyDrop(
    dropUrlkey: $dropUrlkey,
    targetUserUrlkey: $targetUserUrlkey
  ) {
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "dropUrlkey": "abc123",
  "targetUserUrlkey": "xyz789"
}
Response
{
  "data": {
    "copyDrop": {
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": "4",
      "orderId": 4,
      "result": "abc123",
      "type": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

createCartFromOrder

Description

Create cart from an order

Response

Returns a Cart

Arguments
Name Description
id - ID ID of the Order
urlkey - String urlkey of the Order

Example

Query
mutation CreateCartFromOrder(
  $id: ID,
  $urlkey: String
) {
  createCartFromOrder(
    id: $id,
    urlkey: $urlkey
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    updatedAt
    urlkey
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "createCartFromOrder": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerId": 4,
      "cartProducts": [CartProduct],
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "guestId": "4",
      "id": 4,
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": "4",
      "seller": User,
      "sellerId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}

createContact

Use createContactV2 instead
Description

create contacts

Response

Returns a ContactPage

Arguments
Name Description
email - String email of the newly created contact
name - String name of the newly created contact
sellerUserIds - [Int] a list of user ids of sellers (sales reps). Default = []

Example

Query
mutation CreateContact(
  $email: String,
  $name: String,
  $sellerUserIds: [Int]
) {
  createContact(
    email: $email,
    name: $name,
    sellerUserIds: $sellerUserIds
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    group
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    members
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{
  "email": "abc123",
  "name": "xyz789",
  "sellerUserIds": [""]
}
Response
{
  "data": {
    "createContact": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "contactUser": User,
      "contactUserId": "4",
      "currency": "abc123",
      "customId": "abc123",
      "defaultSupplier": 987,
      "discount": 123.45,
      "email": "xyz789",
      "group": 987,
      "id": "4",
      "img": ["xyz789"],
      "invite": true,
      "invoiceAddress": "abc123",
      "invoiceApartment": "xyz789",
      "invoiceCity": "abc123",
      "invoiceCompany": "abc123",
      "invoiceCountry": "abc123",
      "invoiceFirstname": "abc123",
      "invoiceLastname": "abc123",
      "invoicePostalcode": "abc123",
      "invoiceRegion": "abc123",
      "isSuperman": false,
      "isSuperwoman": false,
      "lastInvite": "2007-12-03T10:15:30Z",
      "members": ["abc123"],
      "migrateOldId": "abc123",
      "name": "xyz789",
      "notes": "xyz789",
      "ownerId": "4",
      "paymentBankCustom": "xyz789",
      "paymentEmail": "abc123",
      "paymentIbanCustom": "abc123",
      "paymentMethod": "xyz789",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "abc123",
      "phone": "xyz789",
      "shippingAddress": "xyz789",
      "shippingApartment": "abc123",
      "shippingCity": "abc123",
      "shippingCompany": "abc123",
      "shippingCountry": "abc123",
      "shippingFirstname": "xyz789",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "abc123",
      "shippingRegion": "abc123",
      "showConnectButton": false,
      "showPaymentTaxCode": false,
      "status": 987,
      "termOfPayment": "abc123",
      "type": 987,
      "urlkey": "xyz789"
    }
  }
}

createContactV2

Description

Create a contact

Response

Returns a Contact

Arguments
Name Description
data - ContactInput input data for contact
sellerUserIds - [Int] a list of user ids of sellers (sales reps). Default = []

Example

Query
mutation CreateContactV2(
  $data: ContactInput,
  $sellerUserIds: [Int]
) {
  createContactV2(
    data: $data,
    sellerUserIds: $sellerUserIds
  ) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddress
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    termOfPayment
    type
    urlkey
  }
}
Variables
{"data": ContactInput, "sellerUserIds": [""]}
Response
{
  "data": {
    "createContactV2": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "contactUser": User,
      "contactUserId": 4,
      "currency": "abc123",
      "customId": "abc123",
      "defaultSupplier": 123,
      "discount": 987.65,
      "email": "abc123",
      "id": 4,
      "img": ["xyz789"],
      "invite": true,
      "invoiceAddress": "xyz789",
      "invoiceApartment": "abc123",
      "invoiceCity": "xyz789",
      "invoiceCompany": "abc123",
      "invoiceCountry": "xyz789",
      "invoiceFirstname": "xyz789",
      "invoiceLastname": "xyz789",
      "invoicePostalcode": "abc123",
      "invoiceRegion": "abc123",
      "isSuperman": false,
      "isSuperwoman": true,
      "lastInvite": "2007-12-03T10:15:30Z",
      "migrateOldId": "xyz789",
      "name": "xyz789",
      "notes": "xyz789",
      "ownerId": 4,
      "paymentBankCustom": "abc123",
      "paymentEmail": "xyz789",
      "paymentIbanCustom": "abc123",
      "paymentMethod": "abc123",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "xyz789",
      "phone": "abc123",
      "shippingAddress": "abc123",
      "shippingApartment": "abc123",
      "shippingCity": "xyz789",
      "shippingCompany": "abc123",
      "shippingCountry": "abc123",
      "shippingFirstname": "abc123",
      "shippingLastname": "abc123",
      "shippingPostalcode": "xyz789",
      "shippingRegion": "xyz789",
      "showConnectButton": false,
      "showPaymentTaxCode": false,
      "status": 123,
      "termOfPayment": "xyz789",
      "type": 987,
      "urlkey": "abc123"
    }
  }
}

createDiscount

Description

Create discount

Response

Returns a Discount

Arguments
Name Description
discount - CreateDiscountInput

Example

Query
mutation CreateDiscount($discount: CreateDiscountInput) {
  createDiscount(discount: $discount) {
    active
    applications
    fixedAmountValue
    id
    name
    ownerId
    percentageValue
    quantityOrAmount
    status
    type
    urlkey
    xgetyItems
    xgetyMinimumAmount
    xgetyMinimumQtyItems
    xgetyPercentage
  }
}
Variables
{"discount": CreateDiscountInput}
Response
{
  "data": {
    "createDiscount": {
      "active": true,
      "applications": 987,
      "fixedAmountValue": 987.65,
      "id": "4",
      "name": "xyz789",
      "ownerId": "4",
      "percentageValue": 987.65,
      "quantityOrAmount": 987,
      "status": false,
      "type": 123,
      "urlkey": 4,
      "xgetyItems": "abc123",
      "xgetyMinimumAmount": 987.65,
      "xgetyMinimumQtyItems": 987.65,
      "xgetyPercentage": 987.65
    }
  }
}

createDrop

Response

Returns a Drop

Arguments
Name Description
input - DropInput! Data to be filled out for a new drop

Example

Query
mutation CreateDrop($input: DropInput!) {
  createDrop(input: $input) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    currencySell
    deadline
    deadlineStop
    deliveryEnd
    deliveryStart
    deliveryWindow
    discounts {
      ...DiscountFragment
    }
    discoverable
    dropProducts {
      ...DropProductFragment
    }
    filter
    filters
    id
    images
    img
    info
    isPublic
    lastPromotion
    name
    note
    openrate
    order
    orderItemsQty
    orderQty
    orderTotal
    orderTotalArray {
      ...OrderTotalFragment
    }
    owner {
      ...UserFragment
    }
    ownerId
    pdfGeneratedAt
    pdfUrl
    products {
      ...ProductFragment
    }
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"input": DropInput}
Response
{
  "data": {
    "createDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 123,
      "archive": true,
      "asset": "abc123",
      "assets": ["abc123"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "abc123",
      "currencySell": "abc123",
      "deadline": "2007-12-03T10:15:30Z",
      "deadlineStop": true,
      "deliveryEnd": "2007-12-03",
      "deliveryStart": "2007-12-03",
      "deliveryWindow": "abc123",
      "discounts": [Discount],
      "discoverable": true,
      "dropProducts": [DropProduct],
      "filter": 123,
      "filters": [123],
      "id": "4",
      "images": ["abc123"],
      "img": "abc123",
      "info": "abc123",
      "isPublic": false,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "note": "xyz789",
      "openrate": 123,
      "order": 123,
      "orderItemsQty": 987.65,
      "orderQty": 123,
      "orderTotal": 123.45,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "xyz789",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "xyz789",
      "products": [Product],
      "public": false,
      "publicVisitorCount": 987,
      "rangeDropInt": "abc123",
      "rangeDropText": "xyz789",
      "season": "xyz789",
      "status": 987,
      "supplier": Contact,
      "supplierName": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}

createEvent

Description

Create an event.

Response

Returns an Event

Arguments
Name Description
input - EventInput!

Example

Query
mutation CreateEvent($input: EventInput!) {
  createEvent(input: $input) {
    id
    payload
    type
  }
}
Variables
{"input": EventInput}
Response
{
  "data": {
    "createEvent": {
      "id": "4",
      "payload": Json,
      "type": "xyz789"
    }
  }
}

createIntegrationConfiguration

Description

Mutation for creating a integration_configuration

Response

Returns an IntegrationConfiguration

Arguments
Name Description
input - IntegrationConfigurationInput integration configuration input

Example

Query
mutation CreateIntegrationConfiguration($input: IntegrationConfigurationInput) {
  createIntegrationConfiguration(input: $input) {
    id
    key
    partnerIntegrationId
    value
  }
}
Variables
{"input": IntegrationConfigurationInput}
Response
{
  "data": {
    "createIntegrationConfiguration": {
      "id": 4,
      "key": "abc123",
      "partnerIntegrationId": "4",
      "value": "xyz789"
    }
  }
}

createOrder

Description

Create order from a Cart id/urlkey and a note

Response

Returns an Order

Arguments
Name Description
id - ID Cart urlkey
note - String Commet to be added to the order
rating - Int Rating for the drop
urlkey - String Cart ID

Example

Query
mutation CreateOrder(
  $id: ID,
  $note: String,
  $rating: Int,
  $urlkey: String
) {
  createOrder(
    id: $id,
    note: $note,
    rating: $rating,
    urlkey: $urlkey
  ) {
    appliedDiscountId
    appliedPricelistId
    buyer {
      ...UserFragment
    }
    buyerId
    buyerName
    cancel
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceDate
    invoiceNo
    isSeller
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repId
    rows {
      ...OrderRowFragment
    }
    sellerId
    shippingCosts
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{
  "id": "4",
  "note": "xyz789",
  "rating": 987,
  "urlkey": "abc123"
}
Response
{
  "data": {
    "createOrder": {
      "appliedDiscountId": "4",
      "appliedPricelistId": "4",
      "buyer": User,
      "buyerId": 4,
      "buyerName": "abc123",
      "cancel": true,
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customDiscount": "xyz789",
      "customId": "abc123",
      "discountAmount": 123.45,
      "discountType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 987.65,
      "id": 4,
      "inform": false,
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": false,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "xyz789",
      "owner": User,
      "ownerId": "4",
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 123.45,
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "abc123",
      "rating": 123,
      "rep": User,
      "repId": 4,
      "rows": [OrderRow],
      "sellerId": "4",
      "shippingCosts": 123.45,
      "status": false,
      "sumOfProducts": 123.45,
      "supplierName": "abc123",
      "totalAmount": 123.45,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "vat": 987.65
    }
  }
}

createOrderExtraCost

Response

Returns an OrderExtraCost

Arguments
Name Description
data - OrderExtraCostInput Order extra cost input
orderId - ID! Order ID

Example

Query
mutation CreateOrderExtraCost(
  $data: OrderExtraCostInput,
  $orderId: ID!
) {
  createOrderExtraCost(
    data: $data,
    orderId: $orderId
  ) {
    amount
    id
    name
    taxRatio
  }
}
Variables
{"data": OrderExtraCostInput, "orderId": 4}
Response
{
  "data": {
    "createOrderExtraCost": {
      "amount": 123.45,
      "id": 4,
      "name": "abc123",
      "taxRatio": 123.45
    }
  }
}

createPartnerIntegration

Description

Mutation for creating a partner integration

Response

Returns a PartnerIntegration

Arguments
Name Description
input - PartnerIntegrationInput partner integration input

Example

Query
mutation CreatePartnerIntegration($input: PartnerIntegrationInput) {
  createPartnerIntegration(input: $input) {
    id
    listConfigurations {
      ...IntegrationConfigurationFragment
    }
    name
    owner {
      ...UserFragment
    }
    ownerId
    type
  }
}
Variables
{"input": PartnerIntegrationInput}
Response
{
  "data": {
    "createPartnerIntegration": {
      "id": 4,
      "listConfigurations": [IntegrationConfiguration],
      "name": "abc123",
      "owner": User,
      "ownerId": "4",
      "type": "abc123"
    }
  }
}

createPaymentSubscription

Description

Create paymentSubscription.

Response

Returns a PaymentSubscription

Arguments
Name Description
data - PaymentSubscriptionInput

Example

Query
mutation CreatePaymentSubscription($data: PaymentSubscriptionInput) {
  createPaymentSubscription(data: $data) {
    id
    stripeCustomerId
    stripeProductId
    stripeSubscriptionId
    stripeSubscriptionStatus
  }
}
Variables
{"data": PaymentSubscriptionInput}
Response
{
  "data": {
    "createPaymentSubscription": {
      "id": 4,
      "stripeCustomerId": "xyz789",
      "stripeProductId": "abc123",
      "stripeSubscriptionId": "xyz789",
      "stripeSubscriptionStatus": "abc123"
    }
  }
}

createPricelist

Description

Create pricelist

Response

Returns a Pricelist

Arguments
Name Description
pricelist - CreatePricelistInput!

Example

Query
mutation CreatePricelist($pricelist: CreatePricelistInput!) {
  createPricelist(pricelist: $pricelist) {
    _access {
      ..._PricelistAccessMetaFragment
    }
    _values {
      ..._PricelistValueMetaFragment
    }
    access {
      ...PricelistAccessFragment
    }
    currency
    drop {
      ...DropFragment
    }
    dropId
    dropName
    id
    name
    owner {
      ...UserFragment
    }
    ownerId
    status
    type
    urlkey
    values {
      ...PricelistValueFragment
    }
  }
}
Variables
{"pricelist": CreatePricelistInput}
Response
{
  "data": {
    "createPricelist": {
      "_access": _PricelistAccessMeta,
      "_values": _PricelistValueMeta,
      "access": [PricelistAccess],
      "currency": "abc123",
      "drop": Drop,
      "dropId": 4,
      "dropName": "xyz789",
      "id": 4,
      "name": "abc123",
      "owner": User,
      "ownerId": 4,
      "status": false,
      "type": 987,
      "urlkey": "xyz789",
      "values": [PricelistValue]
    }
  }
}

createPricelistAccess

Description

Create pricelist access

Response

Returns a PricelistAccess

Arguments
Name Description
pricelistAccess - CreatePricelistAccessInput!

Example

Query
mutation CreatePricelistAccess($pricelistAccess: CreatePricelistAccessInput!) {
  createPricelistAccess(pricelistAccess: $pricelistAccess) {
    accessType
    contact {
      ...ContactFragment
    }
    contactId
    contactUserId
    drop {
      ...DropFragment
    }
    dropId
    id
    ownerId
    pricelistId
  }
}
Variables
{"pricelistAccess": CreatePricelistAccessInput}
Response
{
  "data": {
    "createPricelistAccess": {
      "accessType": 987,
      "contact": Contact,
      "contactId": 4,
      "contactUserId": 4,
      "drop": Drop,
      "dropId": "4",
      "id": "4",
      "ownerId": "4",
      "pricelistId": "4"
    }
  }
}

createPricelistValue

Description

Create pricelist value

Response

Returns a PricelistValue

Arguments
Name Description
pricelistValue - CreatePricelistValueInput!

Example

Query
mutation CreatePricelistValue($pricelistValue: CreatePricelistValueInput!) {
  createPricelistValue(pricelistValue: $pricelistValue) {
    drop {
      ...DropFragment
    }
    dropId
    id
    ownerId
    price
    priceList
    pricelistId
    product {
      ...ProductFragment
    }
    productId
    rrp
    rrpList
  }
}
Variables
{"pricelistValue": CreatePricelistValueInput}
Response
{
  "data": {
    "createPricelistValue": {
      "drop": Drop,
      "dropId": "4",
      "id": 4,
      "ownerId": "4",
      "price": 123.45,
      "priceList": 123.45,
      "pricelistId": "4",
      "product": Product,
      "productId": "4",
      "rrp": "abc123",
      "rrpList": "abc123"
    }
  }
}

createProduct

Description

Create product.

Response

Returns a Product

Arguments
Name Description
data - ProductInput Product input

Example

Query
mutation CreateProduct($data: ProductInput) {
  createProduct(data: $data) {
    color
    cost
    createdAt
    customField1
    customField2
    customField3
    customField4
    customField5
    customField6
    customField7
    customField8
    customId
    customIdInt
    customIdText
    ean
    externalProducts {
      ...ExternalProductFragment
    }
    id
    images
    img
    info
    inventoryStock
    inventoryStockLimit
    material
    name
    optionGroups {
      ...ProductOptionGroupFragment
    }
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    rangeProductInt
    rangeProductText
    rrp
    sku
    soldOut
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"data": ProductInput}
Response
{
  "data": {
    "createProduct": {
      "color": "abc123",
      "cost": 987.65,
      "createdAt": "2007-12-03T10:15:30Z",
      "customField1": "abc123",
      "customField2": "abc123",
      "customField3": "abc123",
      "customField4": "xyz789",
      "customField5": "abc123",
      "customField6": "xyz789",
      "customField7": "abc123",
      "customField8": "abc123",
      "customId": "xyz789",
      "customIdInt": "xyz789",
      "customIdText": "abc123",
      "ean": "abc123",
      "externalProducts": [ExternalProduct],
      "id": 4,
      "images": ["abc123"],
      "img": "abc123",
      "info": "xyz789",
      "inventoryStock": "abc123",
      "inventoryStockLimit": "xyz789",
      "material": "xyz789",
      "name": "abc123",
      "optionGroups": [ProductOptionGroup],
      "optionValue1": "abc123",
      "optionValue2": "xyz789",
      "optionValue3": "xyz789",
      "optionValue4": "abc123",
      "optionValue5": "abc123",
      "origin": "abc123",
      "owner": User,
      "ownerId": "xyz789",
      "parent": Product,
      "parentId": 4,
      "parentOrChild": "abc123",
      "price": 987.65,
      "rangeProductInt": "xyz789",
      "rangeProductText": "abc123",
      "rrp": "xyz789",
      "sku": "abc123",
      "soldOut": false,
      "supplier": Contact,
      "supplierId": "4",
      "supplierName": "abc123",
      "taric": "xyz789",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "variants": [Product],
      "variantsV2": [ProductVariant]
    }
  }
}

createProductInBackground

Description

Create product in a backround job.

Response

Returns a BackgroundJob

Arguments
Name Description
data - ProductInput Product input

Example

Query
mutation CreateProductInBackground($data: ProductInput) {
  createProductInBackground(data: $data) {
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"data": ProductInput}
Response
{
  "data": {
    "createProductInBackground": {
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": 4,
      "orderId": "4",
      "result": "xyz789",
      "type": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}

createProductOptions

Description

Create product options.

Response

Returns [ProductOption]

Arguments
Name Description
groupId - ID! Product option group id
names - [String] Option values

Example

Query
mutation CreateProductOptions(
  $groupId: ID!,
  $names: [String]
) {
  createProductOptions(
    groupId: $groupId,
    names: $names
  ) {
    id
    name
    order
  }
}
Variables
{
  "groupId": "4",
  "names": ["xyz789"]
}
Response
{
  "data": {
    "createProductOptions": [
      {
        "id": 4,
        "name": "abc123",
        "order": 123
      }
    ]
  }
}

createProductVariants

Description

Create product variants.

Response

Returns [ProductVariant]

Arguments
Name Description
parentId - ID! Parent product id
variants - [ProductVariantInput] Product variants data

Example

Query
mutation CreateProductVariants(
  $parentId: ID!,
  $variants: [ProductVariantInput]
) {
  createProductVariants(
    parentId: $parentId,
    variants: $variants
  ) {
    color
    cost
    createdAt
    id
    inventoryStock
    optionValue1
    optionValue2
    optionValue3
    optionValue4
    optionValue5
    parent {
      ...ProductFragment
    }
    parentId
    price
    rowOrder
    rrp
    sku
    updatedAt
  }
}
Variables
{"parentId": 4, "variants": [ProductVariantInput]}
Response
{
  "data": {
    "createProductVariants": [
      {
        "color": "abc123",
        "cost": 123.45,
        "createdAt": "2007-12-03T10:15:30Z",
        "id": "4",
        "inventoryStock": "abc123",
        "optionValue1": "abc123",
        "optionValue2": "xyz789",
        "optionValue3": "abc123",
        "optionValue4": "xyz789",
        "optionValue5": "abc123",
        "parent":