API Reference

Order41 - B2B Buying and Selling. Just Better.

We use GraphQL for serving our API, for inforamtion on 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

https://order41.com

Terms of Service

https://order41.com/terms-of-service

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

8.8.53

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

_dropPermissionsMeta

Response

Returns a DropPermissionsMeta

Arguments
Name Description
dropId - ID! ID of the Drop

Example

Query
query _dropPermissionsMeta($dropId: ID!) {
  _dropPermissionsMeta(dropId: $dropId) {
    count
  }
}
Variables
{"dropId": 4}
Response
{"data": {"_dropPermissionsMeta": {"count": 123}}}
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": 987.65,
      "orderQty": 123,
      "orderTotal": 123.45,
      "orderTotalArray": [OrderTotal],
      "productFilters": [DropProductFilter]
    }
  }
}
Queries

_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}}}
Queries

_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": 987}}}
Queries

_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}}}
Queries

_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}}}
Queries

_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}}}
Queries

_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": 123}}}
Queries

_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}}}
Queries

_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": 123}}}
Queries

_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": 987}}}
Queries

_listOnboardingItemsMeta

Response

Returns an OnboardingMeta

Example

Query
query _listOnboardingItemsMeta {
  _listOnboardingItemsMeta {
    completed
    total
  }
}
Response
{"data": {"_listOnboardingItemsMeta": {"completed": 123, "total": 987}}}
Queries

_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": 123}}}
Queries

_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": 987}}}
Queries

_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": 987}}}
Queries

_listReferralsMeta

Description

referrals meta

Response

Returns a ReferralsMeta

Example

Query
query _listReferralsMeta {
  _listReferralsMeta {
    count
  }
}
Response
{"data": {"_listReferralsMeta": {"count": 123}}}
Queries

_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}}}
Queries

_listTeamUsersMeta

Response

Returns a TeamUsersMeta

Example

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

_listUserGroupsMeta

Response

Returns a UserGroupsMeta

Arguments
Name Description
filters - UserGroupFilter filter user groups

Example

Query
query _listUserGroupsMeta($filters: UserGroupFilter) {
  _listUserGroupsMeta(filters: $filters) {
    count
  }
}
Variables
{"filters": UserGroupFilter}
Response
{"data": {"_listUserGroupsMeta": {"count": 987}}}
Queries

bulkContactAddressImportSampleFile

Description

Bulk contact address import sample file.

Response

Returns an Url

Example

Query
query BulkContactAddressImportSampleFile {
  bulkContactAddressImportSampleFile {
    url
  }
}
Response
{
  "data": {
    "bulkContactAddressImportSampleFile": {
      "url": "abc123"
    }
  }
}
Queries

bulkContactImportSampleFile

Description

Bulk contact import sample file.

Response

Returns an Url

Example

Query
query BulkContactImportSampleFile {
  bulkContactImportSampleFile {
    url
  }
}
Response
{
  "data": {
    "bulkContactImportSampleFile": {
      "url": "xyz789"
    }
  }
}
Queries

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
    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
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0}
Response
{
  "data": {
    "discoverDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 123,
        "archive": true,
        "asset": "abc123",
        "assets": ["xyz789"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "abc123",
        "currencyBuy": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "xyz789",
        "discounts": [Discount],
        "discoverable": false,
        "dropLink": "abc123",
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [123],
        "id": 4,
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "xyz789",
        "isPublic": true,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "xyz789",
        "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": "abc123",
        "public": false,
        "publicVisitorCount": 987,
        "rangeDropInt": "abc123",
        "rangeDropText": "abc123",
        "season": "xyz789",
        "sharedWithAll": false,
        "status": 123,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}
Queries

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": 987}}}
Queries

drops

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"first": 25, "offset": 0}
Response
{
  "data": {
    "drops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 987,
        "archive": false,
        "asset": "abc123",
        "assets": ["xyz789"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": true,
        "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": "xyz789",
        "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": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "abc123",
        "public": true,
        "publicVisitorCount": 987,
        "rangeDropInt": "abc123",
        "rangeDropText": "abc123",
        "season": "abc123",
        "sharedWithAll": false,
        "status": 987,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}
Queries

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    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": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "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": [987],
        "id": 4,
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "abc123",
        "isPublic": true,
        "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",
        "public": true,
        "publicVisitorCount": 123,
        "rangeDropInt": "abc123",
        "rangeDropText": "abc123",
        "season": "abc123",
        "sharedWithAll": false,
        "status": 987,
        "supplier": Contact,
        "supplierName": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123"
      }
    ]
  }
}
Queries

exportDropProductImageUrls

Description

Export Drop Product Image Urls

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID drop id
type - SpreadsheetType Default = EXCEL

Example

Query
query ExportDropProductImageUrls(
  $dropId: ID,
  $type: SpreadsheetType
) {
  exportDropProductImageUrls(
    dropId: $dropId,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"dropId": "4", "type": "EXCEL"}
Response
{
  "data": {
    "exportDropProductImageUrls": {
      "cartId": "4",
      "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"
    }
  }
}
Queries

getAddress

Description

get address

Response

Returns an Address

Arguments
Name Description
id - ID ID of the address

Example

Query
query GetAddress($id: ID) {
  getAddress(id: $id) {
    addressLine1
    addressLine2
    city
    company
    country
    description
    email
    firstName
    id
    lastName
    phone
    postalCode
    state
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getAddress": {
      "addressLine1": "abc123",
      "addressLine2": "xyz789",
      "city": "abc123",
      "company": "xyz789",
      "country": "abc123",
      "description": "xyz789",
      "email": "xyz789",
      "firstName": "xyz789",
      "id": "4",
      "lastName": "xyz789",
      "phone": "abc123",
      "postalCode": "abc123",
      "state": "abc123"
    }
  }
}
Queries

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) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getBackgroundJob": {
      "cartId": 4,
      "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"
    }
  }
}
Queries

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
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{"id": 4, "urlkey": "abc123"}
Response
{
  "data": {
    "getCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "guestId": 4,
      "id": 4,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": 4,
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}
Queries

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": "abc123",
      "targetUser": User,
      "term": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Queries

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
    }
    address {
      ...AddressFragment
    }
    addressId
    blockOrdering
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    emailEditable
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    listAddresses {
      ...ContactAddressFragment
    }
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddr {
      ...AddressFragment
    }
    shippingAddress
    shippingAddressId
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    taxRatio
    termOfPayment
    type
    urlkey
    userGroups {
      ...UserGroupFragment
    }
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "getContact": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "address": Address,
      "addressId": "4",
      "blockOrdering": false,
      "contactUser": User,
      "contactUserId": "4",
      "currency": "xyz789",
      "customId": "abc123",
      "defaultSupplier": 987,
      "discount": 987.65,
      "email": "abc123",
      "emailEditable": true,
      "id": 4,
      "img": ["xyz789"],
      "invite": true,
      "invoiceAddress": "abc123",
      "invoiceApartment": "xyz789",
      "invoiceCity": "xyz789",
      "invoiceCompany": "xyz789",
      "invoiceCountry": "abc123",
      "invoiceFirstname": "abc123",
      "invoiceLastname": "xyz789",
      "invoicePostalcode": "abc123",
      "invoiceRegion": "abc123",
      "isSuperman": true,
      "isSuperwoman": false,
      "lastInvite": "2007-12-03T10:15:30Z",
      "listAddresses": [ContactAddress],
      "migrateOldId": "xyz789",
      "name": "xyz789",
      "notes": "xyz789",
      "ownerId": "4",
      "paymentBankCustom": "xyz789",
      "paymentEmail": "abc123",
      "paymentIbanCustom": "abc123",
      "paymentMethod": "abc123",
      "paymentTaxCode": "xyz789",
      "paymentVatCustom": "xyz789",
      "phone": "abc123",
      "shippingAddr": Address,
      "shippingAddress": "abc123",
      "shippingAddressId": "4",
      "shippingApartment": "xyz789",
      "shippingCity": "xyz789",
      "shippingCompany": "abc123",
      "shippingCountry": "xyz789",
      "shippingFirstname": "abc123",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "abc123",
      "shippingRegion": "abc123",
      "showConnectButton": true,
      "showPaymentTaxCode": false,
      "status": 123,
      "taxRatio": 123.45,
      "termOfPayment": "abc123",
      "type": 123,
      "urlkey": "abc123",
      "userGroups": [UserGroup]
    }
  }
}
Queries

getContactAddress

Description

Get a single Contact Address

Response

Returns a ContactAddress

Arguments
Name Description
contactAddressId - ID ID of the contact to retrieve

Example

Query
query GetContactAddress($contactAddressId: ID) {
  getContactAddress(contactAddressId: $contactAddressId) {
    address {
      ...AddressFragment
    }
    addressId
    contactId
    id
  }
}
Variables
{"contactAddressId": "4"}
Response
{
  "data": {
    "getContactAddress": {
      "address": Address,
      "addressId": 4,
      "contactId": "4",
      "id": "4"
    }
  }
}
Queries

getCredential

Description

Get credential for the user.

Response

Returns a Credential

Example

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

getDashboard

Description

Get dashboard data

Response

Returns a Dashboard

Arguments
Name Description
fromDate - DateTime! Compute the statistics starting from this date
toDate - DateTime Compute the statistics up to this date. Default = "2025-12-11T18:09:36.345253"

Example

Query
query GetDashboard(
  $fromDate: DateTime!,
  $toDate: DateTime
) {
  getDashboard(
    fromDate: $fromDate,
    toDate: $toDate
  ) {
    cartsMeta {
      ...QuantityAndAmountsFragment
    }
    dropsMeta {
      ...DropsInfoFragment
    }
    ordersMeta {
      ...QuantityAndAmountsFragment
    }
  }
}
Variables
{
  "fromDate": "2007-12-03T10:15:30Z",
  "toDate": "2025-12-11T18:09:36.345253"
}
Response
{
  "data": {
    "getDashboard": {
      "cartsMeta": QuantityAndAmounts,
      "dropsMeta": DropsInfo,
      "ordersMeta": QuantityAndAmounts
    }
  }
}
Queries

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": false,
      "applications": 987,
      "fixedAmountValue": 987.65,
      "id": "4",
      "name": "abc123",
      "ownerId": 4,
      "percentageValue": 987.65,
      "quantityOrAmount": 987,
      "status": false,
      "type": 987,
      "urlkey": "4",
      "xgetyItems": "xyz789",
      "xgetyMinimumAmount": 987.65,
      "xgetyMinimumQtyItems": 987.65,
      "xgetyPercentage": 987.65
    }
  }
}
Queries

getDiscounts

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": 123.45,
        "id": 4,
        "name": "abc123",
        "ownerId": "4",
        "percentageValue": 987.65,
        "quantityOrAmount": 987,
        "status": true,
        "type": 123,
        "urlkey": 4,
        "xgetyItems": "abc123",
        "xgetyMinimumAmount": 987.65,
        "xgetyMinimumQtyItems": 987.65,
        "xgetyPercentage": 123.45
      }
    ]
  }
}
Queries

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    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": ["xyz789"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "xyz789",
      "deadline": "2007-12-03T10:15:30Z",
      "deadlineStop": true,
      "deliveryEnd": "2007-12-03",
      "deliveryStart": "2007-12-03",
      "deliveryWindow": "xyz789",
      "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": "abc123",
      "note": "abc123",
      "openrate": 987,
      "order": 123,
      "orderItemsQty": 987.65,
      "orderQty": 987,
      "orderTotal": 987.65,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "xyz789",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "abc123",
      "public": true,
      "publicVisitorCount": 987,
      "rangeDropInt": "xyz789",
      "rangeDropText": "xyz789",
      "season": "xyz789",
      "sharedWithAll": true,
      "status": 123,
      "supplier": Contact,
      "supplierName": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}
Queries

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
    }
    teamUserRole
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{"id": 4, "urlkey": "abc123"}
Response
{
  "data": {
    "getDropProfile": {
      "canSearch": true,
      "contacts": [Contact],
      "discoverable": true,
      "displayName": "xyz789",
      "emailProfile": "abc123",
      "facebook": "xyz789",
      "id": 4,
      "image": "xyz789",
      "imageMood": "abc123",
      "images": ["abc123"],
      "img": ["xyz789"],
      "imgMood": ["abc123"],
      "info": "xyz789",
      "instagram": "xyz789",
      "name": "abc123",
      "phone": "abc123",
      "plans": [UserPlan],
      "setting": Setting,
      "teamUserRole": "xyz789",
      "twitter": "xyz789",
      "url": "xyz789",
      "urlName": "abc123",
      "urlkey": "abc123"
    }
  }
}
Queries

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}}}
Queries

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"
    }
  }
}
Queries

getExternalContacts

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": "abc123",
        "extra": "xyz789",
        "partnerIntegrationId": "4"
      }
    ]
  }
}
Queries

getExternalOrders

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": "xyz789",
        "extra": "abc123",
        "orderId": "4",
        "partnerIntegrationId": "4"
      }
    ]
  }
}
Queries

getExternalProducts

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": "xyz789",
        "extra": "abc123",
        "partnerIntegrationId": 4,
        "productId": "4"
      }
    ]
  }
}
Queries

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": "abc123",
      "shopifyApiSecretKey": "xyz789",
      "shopifyUrl": "xyz789"
    }
  }
}
Queries

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": "xyz789",
        "value": "abc123"
      }
    ]
  }
}
Queries

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": "xyz789",
      "value": "xyz789"
    }
  }
}
Queries

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
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"id": 4, "urlkey": "abc123"}
Response
{
  "data": {
    "getOrder": {
      "appliedDiscountId": 4,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "buyerName": "xyz789",
      "cancel": false,
      "cartComment": "xyz789",
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customDiscount": "xyz789",
      "customId": "abc123",
      "discountAmount": 123.45,
      "discountType": "abc123",
      "drop": Drop,
      "dropId": "4",
      "extraCosts": 123.45,
      "id": "4",
      "inform": false,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": true,
      "labelsData": Json,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": 4,
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 987.65,
      "rangeOrderInt": "abc123",
      "rangeOrderText": "xyz789",
      "rating": 987,
      "rep": User,
      "repCredential": Cred,
      "repCredentialId": 4,
      "repId": 4,
      "rows": [OrderRow],
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": 4,
      "shippingCosts": 987.65,
      "showTeamMemberSalesRep": false,
      "status": true,
      "sumOfProducts": 123.45,
      "supplierName": "xyz789",
      "totalAmount": 987.65,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "vat": 123.45
    }
  }
}
Queries

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": "xyz789",
      "owner": User,
      "ownerId": 4,
      "type": "abc123"
    }
  }
}
Queries

getPaymentSubscription

Description

Get paymentSubscription.

Response

Returns a PaymentSubscription

Arguments
Name Description
id - ID

Example

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

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": "xyz789",
      "description": "abc123",
      "id": "4",
      "name": "xyz789"
    }
  }
}
Queries

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
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "getProduct": {
      "color": "xyz789",
      "cost": 123.45,
      "costCurrency": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customField1": "xyz789",
      "customField2": "xyz789",
      "customField3": "xyz789",
      "customField4": "abc123",
      "customField5": "xyz789",
      "customField6": "xyz789",
      "customField7": "xyz789",
      "customField8": "abc123",
      "customId": "abc123",
      "customIdInt": "xyz789",
      "customIdText": "xyz789",
      "ean": "abc123",
      "externalProducts": [ExternalProduct],
      "id": "4",
      "images": ["xyz789"],
      "img": "xyz789",
      "info": "xyz789",
      "inventoryStock": "abc123",
      "inventoryStockLimit": "abc123",
      "material": "abc123",
      "name": "abc123",
      "optionGroups": [ProductOptionGroup],
      "optionValue1": "abc123",
      "optionValue2": "xyz789",
      "optionValue3": "xyz789",
      "origin": "abc123",
      "owner": User,
      "ownerId": "xyz789",
      "parent": Product,
      "parentId": 4,
      "parentOrChild": "abc123",
      "price": 123.45,
      "productUserGroups": [ProductUserGroup],
      "rangeProductInt": "xyz789",
      "rangeProductText": "abc123",
      "rowOrder": 987,
      "rrp": "xyz789",
      "sku": "abc123",
      "soldOut": false,
      "source": "abc123",
      "supplier": Contact,
      "supplierId": "4",
      "supplierName": "xyz789",
      "taric": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "variantCustomField1": "abc123",
      "variantCustomField2": "abc123",
      "variantCustomField3": "xyz789",
      "variants": [Product],
      "variantsV2": [ProductVariant]
    }
  }
}
Queries

getProductsByIds

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
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"productIds": ["4"]}
Response
{
  "data": {
    "getProductsByIds": [
      {
        "color": "abc123",
        "cost": 123.45,
        "costCurrency": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "customField1": "abc123",
        "customField2": "xyz789",
        "customField3": "xyz789",
        "customField4": "abc123",
        "customField5": "xyz789",
        "customField6": "abc123",
        "customField7": "xyz789",
        "customField8": "abc123",
        "customId": "xyz789",
        "customIdInt": "abc123",
        "customIdText": "abc123",
        "ean": "xyz789",
        "externalProducts": [ExternalProduct],
        "id": 4,
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "abc123",
        "inventoryStock": "abc123",
        "inventoryStockLimit": "xyz789",
        "material": "abc123",
        "name": "xyz789",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "abc123",
        "optionValue2": "xyz789",
        "optionValue3": "abc123",
        "origin": "abc123",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "abc123",
        "price": 987.65,
        "productUserGroups": [ProductUserGroup],
        "rangeProductInt": "abc123",
        "rangeProductText": "xyz789",
        "rowOrder": 123,
        "rrp": "xyz789",
        "sku": "abc123",
        "soldOut": true,
        "source": "xyz789",
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "xyz789",
        "taric": "xyz789",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "variantCustomField1": "xyz789",
        "variantCustomField2": "xyz789",
        "variantCustomField3": "abc123",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}
Queries

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
    }
    teamUserRole
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "getProfile": {
      "canSearch": false,
      "contacts": [Contact],
      "discoverable": true,
      "displayName": "xyz789",
      "emailProfile": "xyz789",
      "facebook": "xyz789",
      "id": "4",
      "image": "xyz789",
      "imageMood": "abc123",
      "images": ["abc123"],
      "img": ["xyz789"],
      "imgMood": ["abc123"],
      "info": "abc123",
      "instagram": "xyz789",
      "name": "abc123",
      "phone": "abc123",
      "plans": [UserPlan],
      "setting": Setting,
      "teamUserRole": "xyz789",
      "twitter": "xyz789",
      "url": "abc123",
      "urlName": "abc123",
      "urlkey": "xyz789"
    }
  }
}
Queries

getProfiles

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
    }
    teamUserRole
    twitter
    url
    urlName
    urlkey
  }
}
Response
{
  "data": {
    "getProfiles": [
      {
        "canSearch": true,
        "contacts": [Contact],
        "discoverable": false,
        "displayName": "abc123",
        "emailProfile": "abc123",
        "facebook": "xyz789",
        "id": "4",
        "image": "xyz789",
        "imageMood": "xyz789",
        "images": ["xyz789"],
        "img": ["abc123"],
        "imgMood": ["xyz789"],
        "info": "xyz789",
        "instagram": "abc123",
        "name": "abc123",
        "phone": "abc123",
        "plans": [UserPlan],
        "setting": Setting,
        "teamUserRole": "abc123",
        "twitter": "xyz789",
        "url": "abc123",
        "urlName": "abc123",
        "urlkey": "abc123"
      }
    ]
  }
}
Queries

getQuickbooksIntegrationData

Description

Quickbooks integration data

Response

Returns a QuickbooksIntegrationData

Arguments
Name Description
id - ID id of the partner integration

Example

Query
query GetQuickbooksIntegrationData($id: ID) {
  getQuickbooksIntegrationData(id: $id) {
    doNotSyncProductDescription
    doNotUpdateProducts
    isActive
    isEstimate
    meAsAContactId
    salesRepFieldId
    salesRepFieldName
    syncNotOrderedVariants
    syncOrders
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getQuickbooksIntegrationData": {
      "doNotSyncProductDescription": true,
      "doNotUpdateProducts": false,
      "isActive": true,
      "isEstimate": true,
      "meAsAContactId": "abc123",
      "salesRepFieldId": "xyz789",
      "salesRepFieldName": "xyz789",
      "syncNotOrderedVariants": false,
      "syncOrders": true
    }
  }
}
Queries

getReportData

Response

Returns [SpreadsheetItem]

Arguments
Name Description
dropId - ID
type - ReportType!

Example

Query
query GetReportData(
  $dropId: ID,
  $type: ReportType!
) {
  getReportData(
    dropId: $dropId,
    type: $type
  )
}
Variables
{"dropId": 4, "type": "ORDERS_OVERVIEW"}
Response
{"data": {"getReportData": [SpreadsheetItem]}}
Queries

getSetting

Description

Get user settings

Response

Returns a Setting

Example

Query
query GetSetting {
  getSetting {
    address {
      ...AddressFragment
    }
    addressAddress
    addressApartment
    addressCity
    addressCompany
    addressCountry
    addressFirstname
    addressId
    addressLastname
    addressPostalcode
    autoConnect
    bankIdentifierCode
    chamberOfCommerceNo
    country {
      ...CountryFragment
    }
    currency
    customAttach
    customField1Name
    customField1Status
    customField2Name
    customField2Status
    customField3Name
    customField3Status
    customField4Name
    customField4Status
    customField5Name
    customField5Status
    customField6Name
    customField6Status
    customField7Name
    customField7Status
    customField8Name
    customField8Status
    customInventory
    customInvite
    customInviteSubject
    customOption1Name
    customOption1Status
    customOption2Name
    customOption2Status
    customOption3Name
    customOption3Status
    customOption4Status
    customOption5Status
    customPreorder
    customSeperator
    customThankyou
    customUpdate
    defaultDropTab
    dropPdfTemplate
    fromCsv
    fromEmail
    fromMessage
    fromPdf
    fromSubject
    includeTermsInOrderPdf
    industries
    integrationToken {
      ...TokenFragment
    }
    integrationTokenId
    invoiceText
    orderConfirmPdfTemplate
    ownerId
    parentVariantCombine
    paymentBank
    paymentIban
    paymentVat
    rangeDropInt
    rangeDropText
    rangeOrderInt
    rangeOrderText
    rangeProductInt
    rangeProductText
    rangeSupplierInt
    rangeSupplierText
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    showInDashboard
    termsAndConditions
    termsAndConditionsRequired
    variantCustomField1Name
    variantCustomField2Name
    variantCustomField3Name
  }
}
Response
{
  "data": {
    "getSetting": {
      "address": Address,
      "addressAddress": "xyz789",
      "addressApartment": "xyz789",
      "addressCity": "abc123",
      "addressCompany": "xyz789",
      "addressCountry": "abc123",
      "addressFirstname": "abc123",
      "addressId": "4",
      "addressLastname": "abc123",
      "addressPostalcode": "abc123",
      "autoConnect": true,
      "bankIdentifierCode": "abc123",
      "chamberOfCommerceNo": "abc123",
      "country": Country,
      "currency": "abc123",
      "customAttach": 123,
      "customField1Name": "abc123",
      "customField1Status": 123,
      "customField2Name": "xyz789",
      "customField2Status": 123,
      "customField3Name": "xyz789",
      "customField3Status": 987,
      "customField4Name": "abc123",
      "customField4Status": 123,
      "customField5Name": "abc123",
      "customField5Status": 987,
      "customField6Name": "xyz789",
      "customField6Status": 123,
      "customField7Name": "xyz789",
      "customField7Status": 987,
      "customField8Name": "xyz789",
      "customField8Status": 987,
      "customInventory": 123,
      "customInvite": "abc123",
      "customInviteSubject": "xyz789",
      "customOption1Name": "abc123",
      "customOption1Status": 987,
      "customOption2Name": "abc123",
      "customOption2Status": 987,
      "customOption3Name": "abc123",
      "customOption3Status": 123,
      "customOption4Status": 987,
      "customOption5Status": 123,
      "customPreorder": 123,
      "customSeperator": 123,
      "customThankyou": "xyz789",
      "customUpdate": "xyz789",
      "defaultDropTab": "abc123",
      "dropPdfTemplate": "abc123",
      "fromCsv": false,
      "fromEmail": "abc123",
      "fromMessage": "abc123",
      "fromPdf": true,
      "fromSubject": "xyz789",
      "includeTermsInOrderPdf": true,
      "industries": ["abc123"],
      "integrationToken": Token,
      "integrationTokenId": 4,
      "invoiceText": "xyz789",
      "orderConfirmPdfTemplate": "xyz789",
      "ownerId": 4,
      "parentVariantCombine": false,
      "paymentBank": "xyz789",
      "paymentIban": "abc123",
      "paymentVat": "xyz789",
      "rangeDropInt": "abc123",
      "rangeDropText": "xyz789",
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "xyz789",
      "rangeProductInt": "abc123",
      "rangeProductText": "xyz789",
      "rangeSupplierInt": "abc123",
      "rangeSupplierText": "xyz789",
      "shippingAddress": Address,
      "shippingAddressId": 4,
      "showInDashboard": false,
      "termsAndConditions": "xyz789",
      "termsAndConditionsRequired": false,
      "variantCustomField1Name": "xyz789",
      "variantCustomField2Name": "abc123",
      "variantCustomField3Name": "xyz789"
    }
  }
}
Queries

getSharedSetting

Description

Get shared user settings

Response

Returns a SharedSetting

Arguments
Name Description
urlkey - String The user's urlkey

Example

Query
query GetSharedSetting($urlkey: String) {
  getSharedSetting(urlkey: $urlkey) {
    termsAndConditions
  }
}
Variables
{"urlkey": "xyz789"}
Response
{
  "data": {
    "getSharedSetting": {
      "termsAndConditions": "xyz789"
    }
  }
}
Queries

getShopifyIntegrationData

Description

Shopify integration data

Response

Returns a ShopifyIntegrationData

Arguments
Name Description
id - ID id of the partner integration

Example

Query
query GetShopifyIntegrationData($id: ID) {
  getShopifyIntegrationData(id: $id) {
    isActive
    orderFinancialStatus
    orderSyncStatus
    productsSynced
    syncActiveInventory
    syncCostAsPrice
    syncDraftInventory
    syncOrderUpdates
    syncOrders
    syncPriceAndRrp
    webhooksActivated
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getShopifyIntegrationData": {
      "isActive": true,
      "orderFinancialStatus": "xyz789",
      "orderSyncStatus": "xyz789",
      "productsSynced": false,
      "syncActiveInventory": false,
      "syncCostAsPrice": false,
      "syncDraftInventory": true,
      "syncOrderUpdates": false,
      "syncOrders": false,
      "syncPriceAndRrp": true,
      "webhooksActivated": false
    }
  }
}
Queries

getSubscriptionDetails

Response

Returns a SubscriptionDetails

Example

Query
query GetSubscriptionDetails {
  getSubscriptionDetails {
    cardBrand
    cardLast4
    currency
    email
    nextPaymentDate
    price
    subscribed
  }
}
Response
{
  "data": {
    "getSubscriptionDetails": {
      "cardBrand": "abc123",
      "cardLast4": "xyz789",
      "currency": "abc123",
      "email": "xyz789",
      "nextPaymentDate": "abc123",
      "price": 123.45,
      "subscribed": true
    }
  }
}
Queries

getTeamGroup

Description

Get team group by ID

Response

Returns a TeamGroup

Arguments
Name Description
id - ID! ID of the team group

Example

Query
query GetTeamGroup($id: ID!) {
  getTeamGroup(id: $id) {
    id
    members {
      ...TeamGroupMemberFragment
    }
    name
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getTeamGroup": {
      "id": 4,
      "members": [TeamGroupMember],
      "name": "abc123"
    }
  }
}
Queries

getTeamUser

Description

Get a teamUser by id.

Response

Returns a TeamUser

Arguments
Name Description
id - ID

Example

Query
query GetTeamUser($id: ID) {
  getTeamUser(id: $id) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "getTeamUser": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": false,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": "4",
      "id": "4",
      "role": "xyz789",
      "userId": 4
    }
  }
}
Queries

getUserGroup

Description

Get a userGroup by id.

Response

Returns a UserGroup

Arguments
Name Description
id - ID

Example

Query
query GetUserGroup($id: ID) {
  getUserGroup(id: $id) {
    id
    members {
      ...UserGroupMemberFragment
    }
    name
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "getUserGroup": {
      "id": 4,
      "members": [UserGroupMember],
      "name": "abc123"
    }
  }
}
Queries

listAddresses

Description

list addresses

Response

Returns [Address]

Arguments
Name Description
filters - AddressFilter filter addresses

Example

Query
query ListAddresses($filters: AddressFilter) {
  listAddresses(filters: $filters) {
    addressLine1
    addressLine2
    city
    company
    country
    description
    email
    firstName
    id
    lastName
    phone
    postalCode
    state
  }
}
Variables
{"filters": AddressFilter}
Response
{
  "data": {
    "listAddresses": [
      {
        "addressLine1": "xyz789",
        "addressLine2": "xyz789",
        "city": "xyz789",
        "company": "abc123",
        "country": "abc123",
        "description": "abc123",
        "email": "abc123",
        "firstName": "xyz789",
        "id": 4,
        "lastName": "abc123",
        "phone": "xyz789",
        "postalCode": "xyz789",
        "state": "xyz789"
      }
    ]
  }
}
Queries

listAddressesByCartId

Description

list addresses by cart id

Response

Returns [Address]

Arguments
Name Description
cartId - ID cart id
orderId - ID order id

Example

Query
query ListAddressesByCartId(
  $cartId: ID,
  $orderId: ID
) {
  listAddressesByCartId(
    cartId: $cartId,
    orderId: $orderId
  ) {
    addressLine1
    addressLine2
    city
    company
    country
    description
    email
    firstName
    id
    lastName
    phone
    postalCode
    state
  }
}
Variables
{
  "cartId": "4",
  "orderId": "4"
}
Response
{
  "data": {
    "listAddressesByCartId": [
      {
        "addressLine1": "xyz789",
        "addressLine2": "abc123",
        "city": "abc123",
        "company": "abc123",
        "country": "abc123",
        "description": "xyz789",
        "email": "abc123",
        "firstName": "abc123",
        "id": "4",
        "lastName": "abc123",
        "phone": "abc123",
        "postalCode": "xyz789",
        "state": "abc123"
      }
    ]
  }
}
Queries

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"}
    ]
  }
}
Queries

listCartLabelValues

Description

List cart label values

Response

Returns [CartLabelValue]

Arguments
Name Description
cartId - ID Cart id
cartIds - IdFilter Cart ids
orderId - ID Order id
orderIds - IdFilter Order ids

Example

Query
query ListCartLabelValues(
  $cartId: ID,
  $cartIds: IdFilter,
  $orderId: ID,
  $orderIds: IdFilter
) {
  listCartLabelValues(
    cartId: $cartId,
    cartIds: $cartIds,
    orderId: $orderId,
    orderIds: $orderIds
  ) {
    cartId
    id
    labelId
    orderId
    value
  }
}
Variables
{
  "cartId": "4",
  "cartIds": IdFilter,
  "orderId": 4,
  "orderIds": IdFilter
}
Response
{
  "data": {
    "listCartLabelValues": [
      {
        "cartId": "4",
        "id": "4",
        "labelId": "4",
        "orderId": "4",
        "value": "xyz789"
      }
    ]
  }
}
Queries

listCartProductLabelValues

Description

List cart_product label values

Response

Returns [CartProductLabelValue]

Arguments
Name Description
cartId - ID Cart id
orderId - ID Order id

Example

Query
query ListCartProductLabelValues(
  $cartId: ID,
  $orderId: ID
) {
  listCartProductLabelValues(
    cartId: $cartId,
    orderId: $orderId
  ) {
    cartId
    id
    labelId
    orderId
    productId
    value
  }
}
Variables
{
  "cartId": "4",
  "orderId": "4"
}
Response
{
  "data": {
    "listCartProductLabelValues": [
      {
        "cartId": "4",
        "id": 4,
        "labelId": 4,
        "orderId": "4",
        "productId": 4,
        "value": "abc123"
      }
    ]
  }
}
Queries

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
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listCarts": [
      {
        "_cartProductsMeta": CartProductsMeta,
        "_parentProductsMeta": CartProductsMeta,
        "buyer": User,
        "buyerAddresses": [Address],
        "buyerId": 4,
        "cartProducts": [CartProduct],
        "cartReminderInfo": CartReminderInfo,
        "comment": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "creatorType": "abc123",
        "drop": Drop,
        "dropId": "4",
        "guestId": 4,
        "id": "4",
        "invoiceAddress": Address,
        "invoiceAddressId": 4,
        "isPrivate": true,
        "ownerId": "4",
        "parentProducts": [CartProduct],
        "repId": 4,
        "seller": User,
        "sellerId": 4,
        "shippingAddress": Address,
        "shippingAddressId": 4,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}
Queries

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": "abc123",
        "targetUser": User,
        "term": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

listContactAddressesByCartId

Description

List Contact Addresses by cart_id

Response

Returns [ContactAddress]

Arguments
Name Description
cartId - ID cart id
orderId - ID order id

Example

Query
query ListContactAddressesByCartId(
  $cartId: ID,
  $orderId: ID
) {
  listContactAddressesByCartId(
    cartId: $cartId,
    orderId: $orderId
  ) {
    address {
      ...AddressFragment
    }
    addressId
    contactId
    id
  }
}
Variables
{
  "cartId": "4",
  "orderId": "4"
}
Response
{
  "data": {
    "listContactAddressesByCartId": [
      {
        "address": Address,
        "addressId": "4",
        "contactId": "4",
        "id": 4
      }
    ]
  }
}
Queries

listContactLabelValues

Description

List contact label values

Response

Returns [ContactLabelValue]

Arguments
Name Description
contactId - ID Contact id
contactIds - IdFilter Contact id filter

Example

Query
query ListContactLabelValues(
  $contactId: ID,
  $contactIds: IdFilter
) {
  listContactLabelValues(
    contactId: $contactId,
    contactIds: $contactIds
  ) {
    contactId
    id
    labelId
    value
  }
}
Variables
{"contactId": 4, "contactIds": IdFilter}
Response
{
  "data": {
    "listContactLabelValues": [
      {
        "contactId": "4",
        "id": "4",
        "labelId": 4,
        "value": "xyz789"
      }
    ]
  }
}
Queries

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
    }
    address {
      ...AddressFragment
    }
    addressId
    blockOrdering
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    emailEditable
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    listAddresses {
      ...ContactAddressFragment
    }
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddr {
      ...AddressFragment
    }
    shippingAddress
    shippingAddressId
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    taxRatio
    termOfPayment
    type
    urlkey
    userGroups {
      ...UserGroupFragment
    }
  }
}
Variables
{
  "filter": ContactFilter,
  "first": 100,
  "offset": 0,
  "orderBy": ["ID_DESC"]
}
Response
{
  "data": {
    "listContacts": [
      {
        "accessCustomers": [AccessContact],
        "accessSuppliers": [AccessContact],
        "address": Address,
        "addressId": 4,
        "blockOrdering": true,
        "contactUser": User,
        "contactUserId": "4",
        "currency": "abc123",
        "customId": "xyz789",
        "defaultSupplier": 987,
        "discount": 987.65,
        "email": "abc123",
        "emailEditable": false,
        "id": 4,
        "img": ["xyz789"],
        "invite": false,
        "invoiceAddress": "abc123",
        "invoiceApartment": "xyz789",
        "invoiceCity": "xyz789",
        "invoiceCompany": "xyz789",
        "invoiceCountry": "abc123",
        "invoiceFirstname": "xyz789",
        "invoiceLastname": "abc123",
        "invoicePostalcode": "xyz789",
        "invoiceRegion": "abc123",
        "isSuperman": false,
        "isSuperwoman": false,
        "lastInvite": "2007-12-03T10:15:30Z",
        "listAddresses": [ContactAddress],
        "migrateOldId": "abc123",
        "name": "xyz789",
        "notes": "abc123",
        "ownerId": 4,
        "paymentBankCustom": "abc123",
        "paymentEmail": "abc123",
        "paymentIbanCustom": "abc123",
        "paymentMethod": "abc123",
        "paymentTaxCode": "xyz789",
        "paymentVatCustom": "xyz789",
        "phone": "abc123",
        "shippingAddr": Address,
        "shippingAddress": "abc123",
        "shippingAddressId": "4",
        "shippingApartment": "xyz789",
        "shippingCity": "xyz789",
        "shippingCompany": "abc123",
        "shippingCountry": "xyz789",
        "shippingFirstname": "abc123",
        "shippingLastname": "xyz789",
        "shippingPostalcode": "xyz789",
        "shippingRegion": "abc123",
        "showConnectButton": true,
        "showPaymentTaxCode": false,
        "status": 123,
        "taxRatio": 987.65,
        "termOfPayment": "xyz789",
        "type": 987,
        "urlkey": "xyz789",
        "userGroups": [UserGroup]
      }
    ]
  }
}
Queries

listContactsV2

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
    }
    address {
      ...AddressFragment
    }
    addressId
    blockOrdering
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    emailEditable
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    listAddresses {
      ...ContactAddressFragment
    }
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddr {
      ...AddressFragment
    }
    shippingAddress
    shippingAddressId
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    taxRatio
    termOfPayment
    type
    urlkey
    userGroups {
      ...UserGroupFragment
    }
  }
}
Variables
{
  "filter": ContactFilter,
  "first": 100,
  "offset": 0,
  "orderBy": ["ID_DESC"]
}
Response
{
  "data": {
    "listContactsV2": [
      {
        "accessCustomers": [AccessContact],
        "accessSuppliers": [AccessContact],
        "address": Address,
        "addressId": "4",
        "blockOrdering": false,
        "contactUser": User,
        "contactUserId": 4,
        "currency": "xyz789",
        "customId": "xyz789",
        "defaultSupplier": 987,
        "discount": 987.65,
        "email": "abc123",
        "emailEditable": true,
        "id": "4",
        "img": ["abc123"],
        "invite": true,
        "invoiceAddress": "abc123",
        "invoiceApartment": "abc123",
        "invoiceCity": "abc123",
        "invoiceCompany": "abc123",
        "invoiceCountry": "xyz789",
        "invoiceFirstname": "xyz789",
        "invoiceLastname": "abc123",
        "invoicePostalcode": "xyz789",
        "invoiceRegion": "abc123",
        "isSuperman": true,
        "isSuperwoman": false,
        "lastInvite": "2007-12-03T10:15:30Z",
        "listAddresses": [ContactAddress],
        "migrateOldId": "xyz789",
        "name": "xyz789",
        "notes": "abc123",
        "ownerId": 4,
        "paymentBankCustom": "xyz789",
        "paymentEmail": "abc123",
        "paymentIbanCustom": "xyz789",
        "paymentMethod": "xyz789",
        "paymentTaxCode": "abc123",
        "paymentVatCustom": "abc123",
        "phone": "xyz789",
        "shippingAddr": Address,
        "shippingAddress": "abc123",
        "shippingAddressId": 4,
        "shippingApartment": "xyz789",
        "shippingCity": "xyz789",
        "shippingCompany": "xyz789",
        "shippingCountry": "xyz789",
        "shippingFirstname": "xyz789",
        "shippingLastname": "xyz789",
        "shippingPostalcode": "abc123",
        "shippingRegion": "abc123",
        "showConnectButton": false,
        "showPaymentTaxCode": false,
        "status": 123,
        "taxRatio": 987.65,
        "termOfPayment": "xyz789",
        "type": 123,
        "urlkey": "abc123",
        "userGroups": [UserGroup]
      }
    ]
  }
}
Queries

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": 123,
        "fixedAmountValue": 123.45,
        "id": "4",
        "name": "xyz789",
        "ownerId": 4,
        "percentageValue": 987.65,
        "quantityOrAmount": 987,
        "status": false,
        "type": 123,
        "urlkey": 4,
        "xgetyItems": "abc123",
        "xgetyMinimumAmount": 123.45,
        "xgetyMinimumQtyItems": 123.45,
        "xgetyPercentage": 987.65
      }
    ]
  }
}
Queries

listDropLabelValues

Description

List drop label values

Response

Returns [DropLabelValue]

Arguments
Name Description
dropId - ID drop id
dropIds - IdFilter drop id filter

Example

Query
query ListDropLabelValues(
  $dropId: ID,
  $dropIds: IdFilter
) {
  listDropLabelValues(
    dropId: $dropId,
    dropIds: $dropIds
  ) {
    dropId
    id
    labelId
    value
  }
}
Variables
{
  "dropId": "4",
  "dropIds": IdFilter
}
Response
{
  "data": {
    "listDropLabelValues": [
      {
        "dropId": 4,
        "id": 4,
        "labelId": 4,
        "value": "xyz789"
      }
    ]
  }
}
Queries

listDropPermissions

Response

Returns [DropPermission]

Arguments
Name Description
dropId - ID! ID of the Drop
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 ListDropPermissions(
  $dropId: ID!,
  $first: Int,
  $offset: Int
) {
  listDropPermissions(
    dropId: $dropId,
    first: $first,
    offset: $offset
  ) {
    dropId
    id
    targetContact {
      ...ContactFragment
    }
    targetContactId
    targetUserGroup {
      ...UserGroupFragment
    }
    targetUserGroupId
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{"dropId": "4", "first": 25, "offset": 0}
Response
{
  "data": {
    "listDropPermissions": [
      {
        "dropId": 4,
        "id": 4,
        "targetContact": Contact,
        "targetContactId": 4,
        "targetUserGroup": UserGroup,
        "targetUserGroupId": "4",
        "teamGroup": TeamGroup,
        "teamGroupId": "4",
        "teamUser": TeamUser,
        "teamUserId": 4
      }
    ]
  }
}
Queries

listDropProductLabelValues

Description

List drop product label values

Response

Returns [ProductLabelValue]

Arguments
Name Description
dropId - ID drop id
maybeEmpty - Boolean maybe empty. Default = true
productId - ID product id
productIds - IdFilter Product id filter

Example

Query
query ListDropProductLabelValues(
  $dropId: ID,
  $maybeEmpty: Boolean,
  $productId: ID,
  $productIds: IdFilter
) {
  listDropProductLabelValues(
    dropId: $dropId,
    maybeEmpty: $maybeEmpty,
    productId: $productId,
    productIds: $productIds
  ) {
    id
    labelId
    productId
    value
  }
}
Variables
{
  "dropId": "4",
  "maybeEmpty": true,
  "productId": 4,
  "productIds": IdFilter
}
Response
{
  "data": {
    "listDropProductLabelValues": [
      {
        "id": 4,
        "labelId": "4",
        "productId": "4",
        "value": "abc123"
      }
    ]
  }
}
Queries

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listDrops": [
      {
        "_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": "abc123",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": true,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "xyz789",
        "discounts": [Discount],
        "discoverable": false,
        "dropProducts": [DropProduct],
        "filter": 987,
        "filters": [123],
        "id": "4",
        "images": ["abc123"],
        "img": "xyz789",
        "info": "xyz789",
        "isPublic": true,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "xyz789",
        "note": "xyz789",
        "openrate": 987,
        "order": 123,
        "orderItemsQty": 987.65,
        "orderQty": 123,
        "orderTotal": 123.45,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "abc123",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "abc123",
        "public": false,
        "publicVisitorCount": 987,
        "rangeDropInt": "abc123",
        "rangeDropText": "xyz789",
        "season": "abc123",
        "sharedWithAll": true,
        "status": 987,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123"
      }
    ]
  }
}
Queries

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": "abc123"
      }
    ]
  }
}
Queries

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": "xyz789",
        "extra": "abc123",
        "partnerIntegrationId": 4
      }
    ]
  }
}
Queries

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": "xyz789",
        "extra": "xyz789",
        "orderId": "4",
        "partnerIntegrationId": "4"
      }
    ]
  }
}
Queries

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": "abc123",
        "extra": "abc123",
        "partnerIntegrationId": "4",
        "productId": "4"
      }
    ]
  }
}
Queries

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"
      }
    ]
  }
}
Queries

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": "abc123",
        "partnerIntegrationId": "4",
        "value": "xyz789"
      }
    ]
  }
}
Queries

listLabels

Description

List labels

Response

Returns [Label]

Arguments
Name Description
objectTypes - [String] cart, order ...
sellerId - ID seller id

Example

Query
query ListLabels(
  $objectTypes: [String],
  $sellerId: ID
) {
  listLabels(
    objectTypes: $objectTypes,
    sellerId: $sellerId
  ) {
    id
    name
    objectType
    objectTypes
    public
    selectOptions
    type
  }
}
Variables
{
  "objectTypes": ["xyz789"],
  "sellerId": "4"
}
Response
{
  "data": {
    "listLabels": [
      {
        "id": "4",
        "name": "abc123",
        "objectType": "xyz789",
        "objectTypes": ["xyz789"],
        "public": false,
        "selectOptions": ["abc123"],
        "type": "xyz789"
      }
    ]
  }
}
Queries

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": "abc123",
        "seenAt": "2007-12-03T10:15:30Z",
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

listOnboardingItems

Response

Returns [OnboardingItem]

Example

Query
query ListOnboardingItems {
  listOnboardingItems {
    completed
    description
    id
    link
  }
}
Response
{
  "data": {
    "listOnboardingItems": [
      {
        "completed": true,
        "description": "abc123",
        "id": 4,
        "link": "xyz789"
      }
    ]
  }
}
Queries

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
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listOrders": [
      {
        "appliedDiscountId": 4,
        "buyer": User,
        "buyerAddresses": [Address],
        "buyerId": "4",
        "buyerName": "abc123",
        "cancel": true,
        "cartComment": "xyz789",
        "comment": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "customDiscount": "xyz789",
        "customId": "abc123",
        "discountAmount": 123.45,
        "discountType": "xyz789",
        "drop": Drop,
        "dropId": "4",
        "extraCosts": 123.45,
        "id": 4,
        "inform": true,
        "invoiceAddress": Address,
        "invoiceAddressId": "4",
        "invoiceDate": "2007-12-03",
        "invoiceNo": "xyz789",
        "isSeller": false,
        "labelsData": Json,
        "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,
        "repCredential": Cred,
        "repCredentialId": 4,
        "repId": 4,
        "rows": [OrderRow],
        "seller": User,
        "sellerId": 4,
        "shippingAddress": Address,
        "shippingAddressId": "4",
        "shippingCosts": 987.65,
        "showTeamMemberSalesRep": true,
        "status": false,
        "sumOfProducts": 123.45,
        "supplierName": "abc123",
        "totalAmount": 987.65,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "vat": 987.65
      }
    ]
  }
}
Queries

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": "abc123",
        "owner": User,
        "ownerId": 4,
        "type": "abc123"
      }
    ]
  }
}
Queries

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
    }
    teamUserRole
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{"first": 10, "offset": 0}
Response
{
  "data": {
    "listPartners": [
      {
        "canSearch": true,
        "contacts": [Contact],
        "discoverable": false,
        "displayName": "abc123",
        "emailProfile": "xyz789",
        "facebook": "xyz789",
        "id": "4",
        "image": "abc123",
        "imageMood": "abc123",
        "images": ["xyz789"],
        "img": ["abc123"],
        "imgMood": ["xyz789"],
        "info": "xyz789",
        "instagram": "abc123",
        "name": "abc123",
        "phone": "abc123",
        "plans": [UserPlan],
        "setting": Setting,
        "teamUserRole": "xyz789",
        "twitter": "abc123",
        "url": "abc123",
        "urlName": "xyz789",
        "urlkey": "xyz789"
      }
    ]
  }
}
Queries

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
    stripePlanName
    stripeProductId
    stripeSubscriptionId
    stripeSubscriptionStatus
  }
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
  "data": {
    "listPaymentSubscriptions": [
      {
        "id": "4",
        "stripeCustomerId": "xyz789",
        "stripePlanName": "xyz789",
        "stripeProductId": "xyz789",
        "stripeSubscriptionId": "xyz789",
        "stripeSubscriptionStatus": "xyz789"
      }
    ]
  }
}
Queries

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"
      }
    ]
  }
}
Queries

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": "abc123",
        "id": "4",
        "name": "abc123"
      }
    ]
  }
}
Queries

listProductLabelValues

Description

List product label values

Response

Returns [ProductLabelValue]

Arguments
Name Description
productId - ID product id
productIds - IdFilter Product id filter

Example

Query
query ListProductLabelValues(
  $productId: ID,
  $productIds: IdFilter
) {
  listProductLabelValues(
    productId: $productId,
    productIds: $productIds
  ) {
    id
    labelId
    productId
    value
  }
}
Variables
{"productId": 4, "productIds": IdFilter}
Response
{
  "data": {
    "listProductLabelValues": [
      {
        "id": "4",
        "labelId": "4",
        "productId": "4",
        "value": "abc123"
      }
    ]
  }
}
Queries

listProductPrices

Description

List product prices

Response

Returns [PricelistValue]

Arguments
Name Description
productIds - [ID] (parent) product ids

Example

Query
query ListProductPrices($productIds: [ID]) {
  listProductPrices(productIds: $productIds) {
    currency
    id
    priceContacts {
      ...PriceContactFragment
    }
    prices {
      ...PriceFragment
    }
    product {
      ...ProductFragment
    }
    productId
  }
}
Variables
{"productIds": ["4"]}
Response
{
  "data": {
    "listProductPrices": [
      {
        "currency": "xyz789",
        "id": "4",
        "priceContacts": [PriceContact],
        "prices": [Price],
        "product": Product,
        "productId": "4"
      }
    ]
  }
}
Queries

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 = [SEARCH_SCORE_DESC, 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
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{
  "filter": {},
  "first": 10,
  "offset": 0,
  "orderBy": ["SEARCH_SCORE_DESC", "ID_DESC"]
}
Response
{
  "data": {
    "listProducts": [
      {
        "color": "abc123",
        "cost": 123.45,
        "costCurrency": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customField1": "xyz789",
        "customField2": "abc123",
        "customField3": "xyz789",
        "customField4": "xyz789",
        "customField5": "abc123",
        "customField6": "abc123",
        "customField7": "abc123",
        "customField8": "xyz789",
        "customId": "xyz789",
        "customIdInt": "abc123",
        "customIdText": "abc123",
        "ean": "xyz789",
        "externalProducts": [ExternalProduct],
        "id": "4",
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "xyz789",
        "inventoryStock": "abc123",
        "inventoryStockLimit": "xyz789",
        "material": "abc123",
        "name": "abc123",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "abc123",
        "optionValue2": "abc123",
        "optionValue3": "abc123",
        "origin": "abc123",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "abc123",
        "price": 123.45,
        "productUserGroups": [ProductUserGroup],
        "rangeProductInt": "abc123",
        "rangeProductText": "abc123",
        "rowOrder": 123,
        "rrp": "xyz789",
        "sku": "xyz789",
        "soldOut": false,
        "source": "xyz789",
        "supplier": Contact,
        "supplierId": 4,
        "supplierName": "xyz789",
        "taric": "xyz789",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "variantCustomField1": "abc123",
        "variantCustomField2": "abc123",
        "variantCustomField3": "xyz789",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}
Queries

listReferrals

Description

referral queries

Response

Returns [Referral]

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 - [ReferralModelOrder] Options for sorting the results. Default = [UPDATED_AT_DESC]

Example

Query
query ListReferrals(
  $first: Int,
  $offset: Int,
  $orderBy: [ReferralModelOrder]
) {
  listReferrals(
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    createdAt
    id
    numberOfPayments
    referred {
      ...UserFragment
    }
    type
    updatedAt
  }
}
Variables
{"first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
  "data": {
    "listReferrals": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "id": 4,
        "numberOfPayments": 987,
        "referred": User,
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    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": true,
        "asset": "xyz789",
        "assets": ["xyz789"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "abc123",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": false,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "abc123",
        "discounts": [Discount],
        "discoverable": false,
        "dropProducts": [DropProduct],
        "filter": 123,
        "filters": [123],
        "id": "4",
        "images": ["abc123"],
        "img": "abc123",
        "info": "abc123",
        "isPublic": true,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "abc123",
        "openrate": 123,
        "order": 987,
        "orderItemsQty": 987.65,
        "orderQty": 987,
        "orderTotal": 123.45,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "xyz789",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "public": true,
        "publicVisitorCount": 987,
        "rangeDropInt": "abc123",
        "rangeDropText": "xyz789",
        "season": "abc123",
        "sharedWithAll": true,
        "status": 123,
        "supplier": Contact,
        "supplierName": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789"
      }
    ]
  }
}
Queries

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"]
  }
}
Queries

listTeamGroups

Description

List team groups

Response

Returns [TeamGroup]

Arguments
Name Description
filter - TeamGroupFilter Filters to be applied on the team groups query. 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 ListTeamGroups(
  $filter: TeamGroupFilter,
  $first: Int,
  $offset: Int
) {
  listTeamGroups(
    filter: $filter,
    first: $first,
    offset: $offset
  ) {
    id
    members {
      ...TeamGroupMemberFragment
    }
    name
  }
}
Variables
{"filter": {}, "first": 100, "offset": 0}
Response
{
  "data": {
    "listTeamGroups": [
      {
        "id": 4,
        "members": [TeamGroupMember],
        "name": "xyz789"
      }
    ]
  }
}
Queries

listTeamGroupsForTeamUser

Description

List team groups for team user

Response

Returns [TeamGroupMember]

Arguments
Name Description
teamUserId - ID Team user id

Example

Query
query ListTeamGroupsForTeamUser($teamUserId: ID) {
  listTeamGroupsForTeamUser(teamUserId: $teamUserId) {
    id
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{"teamUserId": "4"}
Response
{
  "data": {
    "listTeamGroupsForTeamUser": [
      {
        "id": "4",
        "teamGroup": TeamGroup,
        "teamGroupId": "4",
        "teamUser": TeamUser,
        "teamUserId": "4"
      }
    ]
  }
}
Queries

listTeamUsers

Description

List teamUsers

Response

Returns [TeamUser]

Arguments
Name Description
filter - TeamUserFilter Conditions for filter teamUser results
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(
  $filter: TeamUserFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [TeamUserModelOrder]
) {
  listTeamUsers(
    filter: $filter,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{
  "filter": TeamUserFilter,
  "first": 25,
  "offset": 0,
  "orderBy": ["ID_ASC"]
}
Response
{
  "data": {
    "listTeamUsers": [
      {
        "accessSuppliers": [AccessContact],
        "canSeeAllContacts": true,
        "contactPermissions": [ContactPermission],
        "credential": Cred,
        "credentialId": 4,
        "id": 4,
        "role": "xyz789",
        "userId": "4"
      }
    ]
  }
}
Queries

listUserGroupMembers

Description

list userGroupMembers

Response

Returns [UserGroupMember]

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

Example

Query
query ListUserGroupMembers(
  $first: Int,
  $offset: Int,
  $userGroupId: ID
) {
  listUserGroupMembers(
    first: $first,
    offset: $offset,
    userGroupId: $userGroupId
  ) {
    contact {
      ...ContactFragment
    }
    contactId
    id
    userGroupId
  }
}
Variables
{
  "first": 100,
  "offset": 0,
  "userGroupId": "4"
}
Response
{
  "data": {
    "listUserGroupMembers": [
      {
        "contact": Contact,
        "contactId": 4,
        "id": "4",
        "userGroupId": "4"
      }
    ]
  }
}
Queries

listUserGroups

Description

list userGroups

Response

Returns [UserGroup]

Arguments
Name Description
filters - UserGroupFilter filter user groups
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 - [UserGroupModelOrder] Options for sorting the results. Default = [ID_ASC]

Example

Query
query ListUserGroups(
  $filters: UserGroupFilter,
  $first: Int,
  $offset: Int,
  $orderBy: [UserGroupModelOrder]
) {
  listUserGroups(
    filters: $filters,
    first: $first,
    offset: $offset,
    orderBy: $orderBy
  ) {
    id
    members {
      ...UserGroupMemberFragment
    }
    name
  }
}
Variables
{
  "filters": UserGroupFilter,
  "first": 25,
  "offset": 0,
  "orderBy": ["ID_ASC"]
}
Response
{
  "data": {
    "listUserGroups": [
      {
        "id": "4",
        "members": [UserGroupMember],
        "name": "xyz789"
      }
    ]
  }
}
Queries

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": "abc123",
        "webhookEvents": [WebhookEvent]
      }
    ]
  }
}
Queries

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
    }
    teamUserRole
    twitter
    url
    urlName
    urlkey
  }
}
Response
{
  "data": {
    "listWorkspaces": [
      {
        "canSearch": false,
        "contacts": [Contact],
        "discoverable": false,
        "displayName": "xyz789",
        "emailProfile": "xyz789",
        "facebook": "abc123",
        "id": 4,
        "image": "xyz789",
        "imageMood": "xyz789",
        "images": ["abc123"],
        "img": ["xyz789"],
        "imgMood": ["abc123"],
        "info": "abc123",
        "instagram": "xyz789",
        "name": "xyz789",
        "phone": "abc123",
        "plans": [UserPlan],
        "setting": Setting,
        "teamUserRole": "abc123",
        "twitter": "xyz789",
        "url": "abc123",
        "urlName": "xyz789",
        "urlkey": "abc123"
      }
    ]
  }
}
Queries

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": 987.65,
      "totalOrderedItems": 987.65
    }
  }
}
Queries

orders

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
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"first": 25, "offset": 0, "orderFilter": {}}
Response
{
  "data": {
    "orders": [
      {
        "appliedDiscountId": "4",
        "buyer": User,
        "buyerAddresses": [Address],
        "buyerId": "4",
        "buyerName": "abc123",
        "cancel": true,
        "cartComment": "abc123",
        "comment": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "customDiscount": "abc123",
        "customId": "xyz789",
        "discountAmount": 123.45,
        "discountType": "xyz789",
        "drop": Drop,
        "dropId": "4",
        "extraCosts": 123.45,
        "id": "4",
        "inform": false,
        "invoiceAddress": Address,
        "invoiceAddressId": "4",
        "invoiceDate": "2007-12-03",
        "invoiceNo": "xyz789",
        "isSeller": true,
        "labelsData": Json,
        "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,
        "repCredential": Cred,
        "repCredentialId": "4",
        "repId": "4",
        "rows": [OrderRow],
        "seller": User,
        "sellerId": "4",
        "shippingAddress": Address,
        "shippingAddressId": "4",
        "shippingCosts": 987.65,
        "showTeamMemberSalesRep": true,
        "status": true,
        "sumOfProducts": 123.45,
        "supplierName": "xyz789",
        "totalAmount": 987.65,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "vat": 987.65
      }
    ]
  }
}
Queries

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
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"orderIds": [4]}
Response
{
  "data": {
    "ordersByIds": [
      {
        "appliedDiscountId": "4",
        "buyer": User,
        "buyerAddresses": [Address],
        "buyerId": "4",
        "buyerName": "abc123",
        "cancel": false,
        "cartComment": "xyz789",
        "comment": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "customDiscount": "abc123",
        "customId": "abc123",
        "discountAmount": 123.45,
        "discountType": "abc123",
        "drop": Drop,
        "dropId": 4,
        "extraCosts": 123.45,
        "id": "4",
        "inform": true,
        "invoiceAddress": Address,
        "invoiceAddressId": "4",
        "invoiceDate": "2007-12-03",
        "invoiceNo": "xyz789",
        "isSeller": false,
        "labelsData": Json,
        "orderExtraCosts": [OrderExtraCost],
        "orderMeta": OrderMeta,
        "orderTag": "abc123",
        "owner": User,
        "ownerId": "4",
        "parentProducts": [OrderProduct],
        "products": [Product],
        "qty": 123.45,
        "rangeOrderInt": "xyz789",
        "rangeOrderText": "xyz789",
        "rating": 987,
        "rep": User,
        "repCredential": Cred,
        "repCredentialId": "4",
        "repId": "4",
        "rows": [OrderRow],
        "seller": User,
        "sellerId": "4",
        "shippingAddress": Address,
        "shippingAddressId": "4",
        "shippingCosts": 987.65,
        "showTeamMemberSalesRep": true,
        "status": true,
        "sumOfProducts": 123.45,
        "supplierName": "xyz789",
        "totalAmount": 987.65,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "vat": 987.65
      }
    ]
  }
}
Queries

products

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
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"first": 10, "offset": 0}
Response
{
  "data": {
    "products": [
      {
        "color": "xyz789",
        "cost": 987.65,
        "costCurrency": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customField1": "xyz789",
        "customField2": "abc123",
        "customField3": "abc123",
        "customField4": "xyz789",
        "customField5": "abc123",
        "customField6": "xyz789",
        "customField7": "abc123",
        "customField8": "xyz789",
        "customId": "abc123",
        "customIdInt": "xyz789",
        "customIdText": "abc123",
        "ean": "xyz789",
        "externalProducts": [ExternalProduct],
        "id": "4",
        "images": ["xyz789"],
        "img": "abc123",
        "info": "abc123",
        "inventoryStock": "xyz789",
        "inventoryStockLimit": "xyz789",
        "material": "xyz789",
        "name": "abc123",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "abc123",
        "optionValue2": "abc123",
        "optionValue3": "xyz789",
        "origin": "abc123",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "xyz789",
        "price": 123.45,
        "productUserGroups": [ProductUserGroup],
        "rangeProductInt": "xyz789",
        "rangeProductText": "abc123",
        "rowOrder": 123,
        "rrp": "abc123",
        "sku": "abc123",
        "soldOut": false,
        "source": "xyz789",
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "xyz789",
        "taric": "abc123",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "variantCustomField1": "xyz789",
        "variantCustomField2": "abc123",
        "variantCustomField3": "abc123",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}
Queries

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"first": 3, "offset": 0}
Response
{
  "data": {
    "recentDrops": [
      {
        "_dropProductsMeta": ProductsMeta,
        "_products": ProductsMeta,
        "access": 123,
        "archive": true,
        "asset": "xyz789",
        "assets": ["abc123"],
        "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
        "assetsArchiveUrl": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "csvSource": "xyz789",
        "currencyBuy": "xyz789",
        "deadline": "2007-12-03T10:15:30Z",
        "deadlineStop": true,
        "deliveryEnd": "2007-12-03",
        "deliveryStart": "2007-12-03",
        "deliveryWindow": "xyz789",
        "discounts": [Discount],
        "discoverable": true,
        "dropProducts": [DropProduct],
        "filter": 987,
        "filters": [987],
        "id": 4,
        "images": ["abc123"],
        "img": "abc123",
        "info": "abc123",
        "isPublic": false,
        "lastPromotion": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "note": "abc123",
        "openrate": 123,
        "order": 987,
        "orderItemsQty": 987.65,
        "orderQty": 123,
        "orderTotal": 123.45,
        "orderTotalArray": [OrderTotal],
        "owner": User,
        "ownerId": "xyz789",
        "pdfGeneratedAt": "2007-12-03T10:15:30Z",
        "pdfUrl": "xyz789",
        "public": true,
        "publicVisitorCount": 987,
        "rangeDropInt": "abc123",
        "rangeDropText": "xyz789",
        "season": "xyz789",
        "sharedWithAll": false,
        "status": 987,
        "supplier": Contact,
        "supplierName": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123"
      }
    ]
  }
}
Queries

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
    }
    teamUserRole
    twitter
    url
    urlName
    urlkey
  }
}
Variables
{"query": "abc123"}
Response
{
  "data": {
    "searchSellerProfiles": [
      {
        "canSearch": true,
        "contacts": [Contact],
        "discoverable": false,
        "displayName": "xyz789",
        "emailProfile": "xyz789",
        "facebook": "xyz789",
        "id": 4,
        "image": "abc123",
        "imageMood": "abc123",
        "images": ["abc123"],
        "img": ["xyz789"],
        "imgMood": ["xyz789"],
        "info": "abc123",
        "instagram": "abc123",
        "name": "xyz789",
        "phone": "xyz789",
        "plans": [UserPlan],
        "setting": Setting,
        "teamUserRole": "abc123",
        "twitter": "abc123",
        "url": "xyz789",
        "urlName": "abc123",
        "urlkey": "xyz789"
      }
    ]
  }
}
Queries

teamGroupMembers

Description

list members of the team group

Response

Returns [TeamGroupMember]

Arguments
Name Description
id - ID! ID of the team group

Example

Query
query TeamGroupMembers($id: ID!) {
  teamGroupMembers(id: $id) {
    id
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "teamGroupMembers": [
      {
        "id": 4,
        "teamGroup": TeamGroup,
        "teamGroupId": 4,
        "teamUser": TeamUser,
        "teamUserId": "4"
      }
    ]
  }
}
Queries

userProducts

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
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"first": 10, "offset": 0}
Response
{
  "data": {
    "userProducts": [
      {
        "color": "xyz789",
        "cost": 987.65,
        "costCurrency": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customField1": "abc123",
        "customField2": "xyz789",
        "customField3": "abc123",
        "customField4": "xyz789",
        "customField5": "xyz789",
        "customField6": "abc123",
        "customField7": "xyz789",
        "customField8": "xyz789",
        "customId": "xyz789",
        "customIdInt": "abc123",
        "customIdText": "xyz789",
        "ean": "abc123",
        "externalProducts": [ExternalProduct],
        "id": 4,
        "images": ["xyz789"],
        "img": ["xyz789"],
        "info": "xyz789",
        "inventoryStock": "xyz789",
        "inventoryStockLimit": "abc123",
        "material": "xyz789",
        "name": "xyz789",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "abc123",
        "optionValue2": "abc123",
        "optionValue3": "xyz789",
        "origin": "xyz789",
        "owner": User,
        "ownerId": "xyz789",
        "parent": Product,
        "parentId": "4",
        "parentOrChild": "abc123",
        "price": 987.65,
        "productUserGroups": [ProductUserGroup],
        "rangeProductInt": "xyz789",
        "rangeProductText": "abc123",
        "rowOrder": 987,
        "rrp": "abc123",
        "sku": "abc123",
        "soldOut": true,
        "source": "abc123",
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "abc123",
        "taric": "abc123",
        "type": "xyz789",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "variantCustomField1": "xyz789",
        "variantCustomField2": "xyz789",
        "variantCustomField3": "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"
    }
  }
}
Mutations

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
    }
    address {
      ...AddressFragment
    }
    addressId
    blockOrdering
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    emailEditable
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    listAddresses {
      ...ContactAddressFragment
    }
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddr {
      ...AddressFragment
    }
    shippingAddress
    shippingAddressId
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    taxRatio
    termOfPayment
    type
    urlkey
    userGroups {
      ...UserGroupFragment
    }
  }
}
Variables
{
  "customerIds": ["4"],
  "id": "4"
}
Response
{
  "data": {
    "addAccessCustomers": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "address": Address,
      "addressId": "4",
      "blockOrdering": false,
      "contactUser": User,
      "contactUserId": "4",
      "currency": "abc123",
      "customId": "abc123",
      "defaultSupplier": 987,
      "discount": 987.65,
      "email": "abc123",
      "emailEditable": false,
      "id": 4,
      "img": ["xyz789"],
      "invite": true,
      "invoiceAddress": "abc123",
      "invoiceApartment": "abc123",
      "invoiceCity": "xyz789",
      "invoiceCompany": "xyz789",
      "invoiceCountry": "abc123",
      "invoiceFirstname": "xyz789",
      "invoiceLastname": "abc123",
      "invoicePostalcode": "xyz789",
      "invoiceRegion": "abc123",
      "isSuperman": false,
      "isSuperwoman": true,
      "lastInvite": "2007-12-03T10:15:30Z",
      "listAddresses": [ContactAddress],
      "migrateOldId": "xyz789",
      "name": "xyz789",
      "notes": "abc123",
      "ownerId": "4",
      "paymentBankCustom": "abc123",
      "paymentEmail": "xyz789",
      "paymentIbanCustom": "abc123",
      "paymentMethod": "xyz789",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "abc123",
      "phone": "abc123",
      "shippingAddr": Address,
      "shippingAddress": "xyz789",
      "shippingAddressId": "4",
      "shippingApartment": "xyz789",
      "shippingCity": "abc123",
      "shippingCompany": "abc123",
      "shippingCountry": "xyz789",
      "shippingFirstname": "xyz789",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "xyz789",
      "shippingRegion": "xyz789",
      "showConnectButton": false,
      "showPaymentTaxCode": false,
      "status": 123,
      "taxRatio": 987.65,
      "termOfPayment": "abc123",
      "type": 987,
      "urlkey": "abc123",
      "userGroups": [UserGroup]
    }
  }
}
Mutations

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
    }
    address {
      ...AddressFragment
    }
    addressId
    blockOrdering
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    emailEditable
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    listAddresses {
      ...ContactAddressFragment
    }
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddr {
      ...AddressFragment
    }
    shippingAddress
    shippingAddressId
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    taxRatio
    termOfPayment
    type
    urlkey
    userGroups {
      ...UserGroupFragment
    }
  }
}
Variables
{"id": "4", "supplierIds": [4]}
Response
{
  "data": {
    "addAccessSuppliers": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "address": Address,
      "addressId": 4,
      "blockOrdering": false,
      "contactUser": User,
      "contactUserId": "4",
      "currency": "xyz789",
      "customId": "abc123",
      "defaultSupplier": 987,
      "discount": 123.45,
      "email": "xyz789",
      "emailEditable": false,
      "id": "4",
      "img": ["abc123"],
      "invite": false,
      "invoiceAddress": "xyz789",
      "invoiceApartment": "xyz789",
      "invoiceCity": "abc123",
      "invoiceCompany": "abc123",
      "invoiceCountry": "abc123",
      "invoiceFirstname": "xyz789",
      "invoiceLastname": "xyz789",
      "invoicePostalcode": "abc123",
      "invoiceRegion": "abc123",
      "isSuperman": false,
      "isSuperwoman": true,
      "lastInvite": "2007-12-03T10:15:30Z",
      "listAddresses": [ContactAddress],
      "migrateOldId": "xyz789",
      "name": "xyz789",
      "notes": "xyz789",
      "ownerId": 4,
      "paymentBankCustom": "xyz789",
      "paymentEmail": "xyz789",
      "paymentIbanCustom": "xyz789",
      "paymentMethod": "abc123",
      "paymentTaxCode": "abc123",
      "paymentVatCustom": "xyz789",
      "phone": "abc123",
      "shippingAddr": Address,
      "shippingAddress": "abc123",
      "shippingAddressId": 4,
      "shippingApartment": "abc123",
      "shippingCity": "abc123",
      "shippingCompany": "abc123",
      "shippingCountry": "abc123",
      "shippingFirstname": "abc123",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "abc123",
      "shippingRegion": "abc123",
      "showConnectButton": true,
      "showPaymentTaxCode": true,
      "status": 123,
      "taxRatio": 987.65,
      "termOfPayment": "abc123",
      "type": 123,
      "urlkey": "xyz789",
      "userGroups": [UserGroup]
    }
  }
}
Mutations

addCartLabelValue

Description

Add cart label value

Response

Returns a CartLabelValue

Arguments
Name Description
input - CartLabelValueInput

Example

Query
mutation AddCartLabelValue($input: CartLabelValueInput) {
  addCartLabelValue(input: $input) {
    cartId
    id
    labelId
    orderId
    value
  }
}
Variables
{"input": CartLabelValueInput}
Response
{
  "data": {
    "addCartLabelValue": {
      "cartId": 4,
      "id": 4,
      "labelId": "4",
      "orderId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

addCartProductLabelValue

Description

Add cart product label value

Response

Returns a CartProductLabelValue

Arguments
Name Description
input - CartProductLabelValueInput

Example

Query
mutation AddCartProductLabelValue($input: CartProductLabelValueInput) {
  addCartProductLabelValue(input: $input) {
    cartId
    id
    labelId
    orderId
    productId
    value
  }
}
Variables
{"input": CartProductLabelValueInput}
Response
{
  "data": {
    "addCartProductLabelValue": {
      "cartId": "4",
      "id": 4,
      "labelId": 4,
      "orderId": "4",
      "productId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

addContactLabelValue

Description

Add contact label value

Response

Returns a ContactLabelValue

Arguments
Name Description
input - ContactLabelValueInput

Example

Query
mutation AddContactLabelValue($input: ContactLabelValueInput) {
  addContactLabelValue(input: $input) {
    contactId
    id
    labelId
    value
  }
}
Variables
{"input": ContactLabelValueInput}
Response
{
  "data": {
    "addContactLabelValue": {
      "contactId": 4,
      "id": 4,
      "labelId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

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"
    }
  }
}
Mutations

addDropLabelValue

Description

Add drop label value

Response

Returns a DropLabelValue

Arguments
Name Description
input - DropLabelValueInput

Example

Query
mutation AddDropLabelValue($input: DropLabelValueInput) {
  addDropLabelValue(input: $input) {
    dropId
    id
    labelId
    value
  }
}
Variables
{"input": DropLabelValueInput}
Response
{
  "data": {
    "addDropLabelValue": {
      "dropId": "4",
      "id": 4,
      "labelId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

addDropPermission

Description

Add a drop permission. (or share a drop)

Response

Returns a DropPermission

Arguments
Name Description
contactId - ID ID of the contact
dropId - ID ID of the Drop
teamGroupId - ID ID of the team group
teamUserId - ID ID of the team user
userGroupId - ID ID of the user group

Example

Query
mutation AddDropPermission(
  $contactId: ID,
  $dropId: ID,
  $teamGroupId: ID,
  $teamUserId: ID,
  $userGroupId: ID
) {
  addDropPermission(
    contactId: $contactId,
    dropId: $dropId,
    teamGroupId: $teamGroupId,
    teamUserId: $teamUserId,
    userGroupId: $userGroupId
  ) {
    dropId
    id
    targetContact {
      ...ContactFragment
    }
    targetContactId
    targetUserGroup {
      ...UserGroupFragment
    }
    targetUserGroupId
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{
  "contactId": 4,
  "dropId": 4,
  "teamGroupId": "4",
  "teamUserId": "4",
  "userGroupId": "4"
}
Response
{
  "data": {
    "addDropPermission": {
      "dropId": "4",
      "id": 4,
      "targetContact": Contact,
      "targetContactId": 4,
      "targetUserGroup": UserGroup,
      "targetUserGroupId": "4",
      "teamGroup": TeamGroup,
      "teamGroupId": 4,
      "teamUser": TeamUser,
      "teamUserId": 4
    }
  }
}
Mutations

addLabel

Description

Add label

Response

Returns a Label

Arguments
Name Description
input - LabelInput

Example

Query
mutation AddLabel($input: LabelInput) {
  addLabel(input: $input) {
    id
    name
    objectType
    objectTypes
    public
    selectOptions
    type
  }
}
Variables
{"input": LabelInput}
Response
{
  "data": {
    "addLabel": {
      "id": "4",
      "name": "abc123",
      "objectType": "xyz789",
      "objectTypes": ["xyz789"],
      "public": false,
      "selectOptions": ["abc123"],
      "type": "abc123"
    }
  }
}
Mutations

addMemberToUserGroup

Description

Add member to user group.

Response

Returns a UserGroupMember

Arguments
Name Description
contactId - ID
userGroupId - ID

Example

Query
mutation AddMemberToUserGroup(
  $contactId: ID,
  $userGroupId: ID
) {
  addMemberToUserGroup(
    contactId: $contactId,
    userGroupId: $userGroupId
  ) {
    contact {
      ...ContactFragment
    }
    contactId
    id
    userGroupId
  }
}
Variables
{"contactId": 4, "userGroupId": 4}
Response
{
  "data": {
    "addMemberToUserGroup": {
      "contact": Contact,
      "contactId": "4",
      "id": 4,
      "userGroupId": "4"
    }
  }
}
Mutations

addPriceContact

Description

Add price contact.

Response

Returns a PriceContact

Arguments
Name Description
data - PriceContactInput Price contact input

Example

Query
mutation AddPriceContact($data: PriceContactInput) {
  addPriceContact(data: $data) {
    contactId
    id
    priceId
    userGroupId
  }
}
Variables
{"data": PriceContactInput}
Response
{
  "data": {
    "addPriceContact": {
      "contactId": 4,
      "id": "4",
      "priceId": 4,
      "userGroupId": "4"
    }
  }
}
Mutations

addProductGroup

Description

Add product group

Response

Returns a ProductUserGroup

Arguments
Name Description
productId - ID Product ID
userGroupId - ID Group ID

Example

Query
mutation AddProductGroup(
  $productId: ID,
  $userGroupId: ID
) {
  addProductGroup(
    productId: $productId,
    userGroupId: $userGroupId
  ) {
    id
    userGroup {
      ...UserGroupFragment
    }
  }
}
Variables
{"productId": 4, "userGroupId": "4"}
Response
{
  "data": {
    "addProductGroup": {
      "id": "4",
      "userGroup": UserGroup
    }
  }
}
Mutations

addProductLabelValue

Description

Add product label value

Response

Returns a ProductLabelValue

Arguments
Name Description
input - ProductLabelValueInput

Example

Query
mutation AddProductLabelValue($input: ProductLabelValueInput) {
  addProductLabelValue(input: $input) {
    id
    labelId
    productId
    value
  }
}
Variables
{"input": ProductLabelValueInput}
Response
{
  "data": {
    "addProductLabelValue": {
      "id": 4,
      "labelId": 4,
      "productId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

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
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{
  "id": "4",
  "productId": "4",
  "quantity": 123.45,
  "urlkey": "abc123"
}
Response
{
  "data": {
    "addProductToOrder": {
      "appliedDiscountId": "4",
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "buyerName": "abc123",
      "cancel": true,
      "cartComment": "xyz789",
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customDiscount": "xyz789",
      "customId": "abc123",
      "discountAmount": 123.45,
      "discountType": "xyz789",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 987.65,
      "id": 4,
      "inform": false,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": false,
      "labelsData": Json,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": "4",
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 987.65,
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "xyz789",
      "rating": 987,
      "rep": User,
      "repCredential": Cred,
      "repCredentialId": 4,
      "repId": "4",
      "rows": [OrderRow],
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": 4,
      "shippingCosts": 123.45,
      "showTeamMemberSalesRep": false,
      "status": false,
      "sumOfProducts": 987.65,
      "supplierName": "xyz789",
      "totalAmount": 123.45,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "vat": 123.45
    }
  }
}
Mutations

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": 123}}
Mutations

addTeamGroupMember

Description

Add a member to a team group

Response

Returns a TeamGroupMember

Arguments
Name Description
id - ID! ID of the team group
teamUserId - ID! ID of the team user to add

Example

Query
mutation AddTeamGroupMember(
  $id: ID!,
  $teamUserId: ID!
) {
  addTeamGroupMember(
    id: $id,
    teamUserId: $teamUserId
  ) {
    id
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{"id": 4, "teamUserId": 4}
Response
{
  "data": {
    "addTeamGroupMember": {
      "id": "4",
      "teamGroup": TeamGroup,
      "teamGroupId": 4,
      "teamUser": TeamUser,
      "teamUserId": "4"
    }
  }
}
Mutations

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
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"email": "xyz789", "role": "ADMIN"}
Response
{
  "data": {
    "addTeamUser": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": true,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": 4,
      "id": "4",
      "role": "xyz789",
      "userId": "4"
    }
  }
}
Mutations

addToCart

Description

Add products to an existing or new cart

Response

Returns a Cart

Arguments
Name Description
input - AddToCartInput

Example

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

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}}
Mutations

aiGenerateCart

Description

Generates a cart based on user prompt.

Response

Returns a Cart

Arguments
Name Description
dropId - ID! Drop id from which to take the product for the new cart
prompt - String Free text instru

Example

Query
mutation AiGenerateCart(
  $dropId: ID!,
  $prompt: String
) {
  aiGenerateCart(
    dropId: $dropId,
    prompt: $prompt
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{
  "dropId": "4",
  "prompt": "abc123"
}
Response
{
  "data": {
    "aiGenerateCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "guestId": "4",
      "id": "4",
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "isPrivate": true,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": 4,
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}
Mutations

assignAddressesToCart

Description

Assign shipping and invoice addresses

Response

Returns a Cart

Arguments
Name Description
id - ID ID of the Cart

Example

Query
mutation AssignAddressesToCart($id: ID) {
  assignAddressesToCart(id: $id) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "assignAddressesToCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": "4",
      "guestId": "4",
      "id": 4,
      "invoiceAddress": Address,
      "invoiceAddressId": 4,
      "isPrivate": false,
      "ownerId": "4",
      "parentProducts": [CartProduct],
      "repId": 4,
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

autoGenerateCart

Description

Generates a suggestion 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
prompt - String Free text instructions for cart generation
suggestedValue - Int Suggested cart value in the UI - used for informative purposes only
value - Int Desired cart monetary value in whole numbers

Example

Query
mutation AutoGenerateCart(
  $buyerId: ID,
  $dropId: ID!,
  $prompt: String,
  $suggestedValue: Int,
  $value: Int
) {
  autoGenerateCart(
    buyerId: $buyerId,
    dropId: $dropId,
    prompt: $prompt,
    suggestedValue: $suggestedValue,
    value: $value
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{
  "buyerId": 4,
  "dropId": "4",
  "prompt": "abc123",
  "suggestedValue": 123,
  "value": 987
}
Response
{
  "data": {
    "autoGenerateCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": "4",
      "guestId": 4,
      "id": "4",
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": "4",
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": 4,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

bulkCartLabelValueCud

Description

bulk cart label value CUD - (create - update - delete)

Response

Returns an ActionResult

Arguments
Name Description
input - [CartLabelValueCudInput]

Example

Query
mutation BulkCartLabelValueCud($input: [CartLabelValueCudInput]) {
  bulkCartLabelValueCud(input: $input) {
    message
    success
  }
}
Variables
{"input": [CartLabelValueCudInput]}
Response
{
  "data": {
    "bulkCartLabelValueCud": {
      "message": "xyz789",
      "success": false
    }
  }
}
Mutations

bulkContactLabelValueCud

Description

bulk contact label value CUD - (create - update - delete)

Response

Returns an ActionResult

Arguments
Name Description
input - [ContactLabelValueCudInput]

Example

Query
mutation BulkContactLabelValueCud($input: [ContactLabelValueCudInput]) {
  bulkContactLabelValueCud(input: $input) {
    message
    success
  }
}
Variables
{"input": [ContactLabelValueCudInput]}
Response
{
  "data": {
    "bulkContactLabelValueCud": {
      "message": "abc123",
      "success": true
    }
  }
}
Mutations

bulkDropLabelValueCud

Description

bulk drop label value CUD - (create - update - delete)

Response

Returns an ActionResult

Arguments
Name Description
input - [DropLabelValueCudInput]

Example

Query
mutation BulkDropLabelValueCud($input: [DropLabelValueCudInput]) {
  bulkDropLabelValueCud(input: $input) {
    message
    success
  }
}
Variables
{"input": [DropLabelValueCudInput]}
Response
{
  "data": {
    "bulkDropLabelValueCud": {
      "message": "abc123",
      "success": false
    }
  }
}
Mutations

bulkProductImportSampleFile

Description

Bulk product import sample file.

Response

Returns an Url

Example

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

bulkProductLabelValueCud

Description

bulk product label value CUD - (create - update - delete)

Response

Returns an ActionResult

Arguments
Name Description
input - [ProductLabelValueCudInput]

Example

Query
mutation BulkProductLabelValueCud($input: [ProductLabelValueCudInput]) {
  bulkProductLabelValueCud(input: $input) {
    message
    success
  }
}
Variables
{"input": [ProductLabelValueCudInput]}
Response
{
  "data": {
    "bulkProductLabelValueCud": {
      "message": "abc123",
      "success": false
    }
  }
}
Mutations

bulkProductPriceCud

Description

Pricelist values bulk operations

Response

Returns an ActionResult

Arguments
Name Description
input - [ProductPriceCudInput]

Example

Query
mutation BulkProductPriceCud($input: [ProductPriceCudInput]) {
  bulkProductPriceCud(input: $input) {
    message
    success
  }
}
Variables
{"input": [ProductPriceCudInput]}
Response
{
  "data": {
    "bulkProductPriceCud": {
      "message": "xyz789",
      "success": true
    }
  }
}
Mutations

cancelAllPaymentSubscriptions

Response

Returns an ActionResult

Example

Query
mutation CancelAllPaymentSubscriptions {
  cancelAllPaymentSubscriptions {
    message
    success
  }
}
Response
{
  "data": {
    "cancelAllPaymentSubscriptions": {
      "message": "abc123",
      "success": false
    }
  }
}
Mutations

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
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "email": "xyz789",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "copyDemoAccount": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

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
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "dropUrlkey": "xyz789",
  "targetUserUrlkey": "abc123"
}
Response
{
  "data": {
    "copyDrop": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

createAddress

Description

create address

Response

Returns an Address

Arguments
Name Description
data - AddressInput Address data

Example

Query
mutation CreateAddress($data: AddressInput) {
  createAddress(data: $data) {
    addressLine1
    addressLine2
    city
    company
    country
    description
    email
    firstName
    id
    lastName
    phone
    postalCode
    state
  }
}
Variables
{"data": AddressInput}
Response
{
  "data": {
    "createAddress": {
      "addressLine1": "xyz789",
      "addressLine2": "abc123",
      "city": "abc123",
      "company": "xyz789",
      "country": "xyz789",
      "description": "xyz789",
      "email": "abc123",
      "firstName": "xyz789",
      "id": 4,
      "lastName": "xyz789",
      "phone": "xyz789",
      "postalCode": "xyz789",
      "state": "abc123"
    }
  }
}
Mutations

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
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "abc123"
}
Response
{
  "data": {
    "createCartFromOrder": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": "4",
      "guestId": 4,
      "id": 4,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": "4",
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

createContact

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

Example

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

createContactAddress

Description

create contact address

Response

Returns a ContactAddress

Arguments
Name Description
addressInput - AddressInput Address input
contactId - ID Contact id

Example

Query
mutation CreateContactAddress(
  $addressInput: AddressInput,
  $contactId: ID
) {
  createContactAddress(
    addressInput: $addressInput,
    contactId: $contactId
  ) {
    address {
      ...AddressFragment
    }
    addressId
    contactId
    id
  }
}
Variables
{"addressInput": AddressInput, "contactId": 4}
Response
{
  "data": {
    "createContactAddress": {
      "address": Address,
      "addressId": "4",
      "contactId": 4,
      "id": "4"
    }
  }
}
Mutations

createContactV2

Description

Create a contact

Response

Returns a Contact

Arguments
Name Description
data - ContactInput input data for contact

Example

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

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": 123,
      "fixedAmountValue": 123.45,
      "id": "4",
      "name": "xyz789",
      "ownerId": 4,
      "percentageValue": 123.45,
      "quantityOrAmount": 123,
      "status": false,
      "type": 123,
      "urlkey": "4",
      "xgetyItems": "abc123",
      "xgetyMinimumAmount": 123.45,
      "xgetyMinimumQtyItems": 123.45,
      "xgetyPercentage": 987.65
    }
  }
}
Mutations

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
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{"input": DropInput}
Response
{
  "data": {
    "createDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 123,
      "archive": false,
      "asset": "abc123",
      "assets": ["xyz789"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "xyz789",
      "deadline": "2007-12-03T10:15:30Z",
      "deadlineStop": true,
      "deliveryEnd": "2007-12-03",
      "deliveryStart": "2007-12-03",
      "deliveryWindow": "xyz789",
      "discounts": [Discount],
      "discoverable": true,
      "dropProducts": [DropProduct],
      "filter": 987,
      "filters": [123],
      "id": 4,
      "images": ["xyz789"],
      "img": "abc123",
      "info": "abc123",
      "isPublic": true,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "note": "xyz789",
      "openrate": 123,
      "order": 987,
      "orderItemsQty": 123.45,
      "orderQty": 123,
      "orderTotal": 987.65,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "abc123",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "abc123",
      "public": false,
      "publicVisitorCount": 123,
      "rangeDropInt": "abc123",
      "rangeDropText": "abc123",
      "season": "abc123",
      "sharedWithAll": true,
      "status": 987,
      "supplier": Contact,
      "supplierName": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}
Mutations

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"
    }
  }
}
Mutations

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": "xyz789",
      "partnerIntegrationId": "4",
      "value": "xyz789"
    }
  }
}
Mutations

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
shippingAddressId - ID Shipping address id
urlkey - String Cart ID

Example

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

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": 987.65,
      "id": 4,
      "name": "abc123",
      "taxRatio": 123.45
    }
  }
}
Mutations

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": "xyz789",
      "owner": User,
      "ownerId": 4,
      "type": "abc123"
    }
  }
}
Mutations

createPaymentSubscription

Description

Create paymentSubscription.

Response

Returns a PaymentSubscription

Arguments
Name Description
data - PaymentSubscriptionInput

Example

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

createPricelistValue

Description

Create pricelist value

Response

Returns a PricelistValue

Arguments
Name Description
pricelistValue - CreatePricelistValueInput!

Example

Query
mutation CreatePricelistValue($pricelistValue: CreatePricelistValueInput!) {
  createPricelistValue(pricelistValue: $pricelistValue) {
    currency
    id
    priceContacts {
      ...PriceContactFragment
    }
    prices {
      ...PriceFragment
    }
    product {
      ...ProductFragment
    }
    productId
  }
}
Variables
{"pricelistValue": CreatePricelistValueInput}
Response
{
  "data": {
    "createPricelistValue": {
      "currency": "abc123",
      "id": "4",
      "priceContacts": [PriceContact],
      "prices": [Price],
      "product": Product,
      "productId": "4"
    }
  }
}
Mutations

createProduct

Description

Create product.

Response

Returns a Product

Arguments
Name Description
data - ProductInput Product input
defaultVariant - Boolean Add a default variant to the parent. Default = false

Example

Query
mutation CreateProduct(
  $data: ProductInput,
  $defaultVariant: Boolean
) {
  createProduct(
    data: $data,
    defaultVariant: $defaultVariant
  ) {
    color
    cost
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"data": ProductInput, "defaultVariant": false}
Response
{
  "data": {
    "createProduct": {
      "color": "abc123",
      "cost": 123.45,
      "costCurrency": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customField1": "xyz789",
      "customField2": "abc123",
      "customField3": "xyz789",
      "customField4": "abc123",
      "customField5": "abc123",
      "customField6": "abc123",
      "customField7": "abc123",
      "customField8": "abc123",
      "customId": "xyz789",
      "customIdInt": "xyz789",
      "customIdText": "abc123",
      "ean": "abc123",
      "externalProducts": [ExternalProduct],
      "id": 4,
      "images": ["abc123"],
      "img": "xyz789",
      "info": "abc123",
      "inventoryStock": "abc123",
      "inventoryStockLimit": "abc123",
      "material": "xyz789",
      "name": "abc123",
      "optionGroups": [ProductOptionGroup],
      "optionValue1": "abc123",
      "optionValue2": "xyz789",
      "optionValue3": "xyz789",
      "origin": "abc123",
      "owner": User,
      "ownerId": "abc123",
      "parent": Product,
      "parentId": 4,
      "parentOrChild": "abc123",
      "price": 987.65,
      "productUserGroups": [ProductUserGroup],
      "rangeProductInt": "abc123",
      "rangeProductText": "abc123",
      "rowOrder": 987,
      "rrp": "xyz789",
      "sku": "abc123",
      "soldOut": false,
      "source": "xyz789",
      "supplier": Contact,
      "supplierId": "4",
      "supplierName": "xyz789",
      "taric": "xyz789",
      "type": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "variantCustomField1": "xyz789",
      "variantCustomField2": "abc123",
      "variantCustomField3": "abc123",
      "variants": [Product],
      "variantsV2": [ProductVariant]
    }
  }
}
Mutations

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) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"data": ProductInput}
Response
{
  "data": {
    "createProductInBackground": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

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
      }
    ]
  }
}
Mutations

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
    costCurrency
    createdAt
    currency
    customId
    id
    images
    inventoryStock
    optionValue1
    optionValue2
    optionValue3
    parent {
      ...ProductFragment
    }
    parentId
    price
    priceCurrency
    rowOrder
    rrp
    rrpCurrency
    sellWhenOos
    sku
    soldOut
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
  }
}
Variables
{"parentId": 4, "variants": [ProductVariantInput]}
Response
{
  "data": {
    "createProductVariants": [
      {
        "color": "abc123",
        "cost": 987.65,
        "costCurrency": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "abc123",
        "customId": "abc123",
        "id": 4,
        "images": ["xyz789"],
        "inventoryStock": "xyz789",
        "optionValue1": "xyz789",
        "optionValue2": "xyz789",
        "optionValue3": "abc123",
        "parent": Product,
        "parentId": 4,
        "price": 987.65,
        "priceCurrency": "abc123",
        "rowOrder": 987,
        "rrp": "xyz789",
        "rrpCurrency": "xyz789",
        "sellWhenOos": false,
        "sku": "xyz789",
        "soldOut": false,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "xyz789",
        "variantCustomField1": "xyz789",
        "variantCustomField2": "abc123",
        "variantCustomField3": "abc123"
      }
    ]
  }
}
Mutations

createShopifyIntegration

Description

Mutation for creating a shopify integration

Response

Returns a ShopifyIntegration

Arguments
Name Description
queryString - String

Example

Query
mutation CreateShopifyIntegration($queryString: String) {
  createShopifyIntegration(queryString: $queryString) {
    alreadyRegistered
    redirectUri
  }
}
Variables
{"queryString": "abc123"}
Response
{
  "data": {
    "createShopifyIntegration": {
      "alreadyRegistered": "abc123",
      "redirectUri": "xyz789"
    }
  }
}
Mutations

createTeamGroup

Description

Create a team group

Response

Returns a TeamGroup

Arguments
Name Description
name - String! Name of the team group

Example

Query
mutation CreateTeamGroup($name: String!) {
  createTeamGroup(name: $name) {
    id
    members {
      ...TeamGroupMemberFragment
    }
    name
  }
}
Variables
{"name": "xyz789"}
Response
{
  "data": {
    "createTeamGroup": {
      "id": 4,
      "members": [TeamGroupMember],
      "name": "xyz789"
    }
  }
}
Mutations

createUserGroup

Description

create userGroup

Response

Returns a UserGroup

Arguments
Name Description
name - String

Example

Query
mutation CreateUserGroup($name: String) {
  createUserGroup(name: $name) {
    id
    members {
      ...UserGroupMemberFragment
    }
    name
  }
}
Variables
{"name": "abc123"}
Response
{
  "data": {
    "createUserGroup": {
      "id": 4,
      "members": [UserGroupMember],
      "name": "abc123"
    }
  }
}
Mutations

createWebhook

Description

webhoook mutations

Response

Returns a Webhook

Arguments
Name Description
data - WebhookInput webhook input data

Example

Query
mutation CreateWebhook($data: WebhookInput) {
  createWebhook(data: $data) {
    headers
    id
    owner {
      ...UserFragment
    }
    ownerId
    password
    url
    userName
    webhookEvents {
      ...WebhookEventFragment
    }
  }
}
Variables
{"data": WebhookInput}
Response
{
  "data": {
    "createWebhook": {
      "headers": Json,
      "id": 4,
      "owner": User,
      "ownerId": "4",
      "password": "xyz789",
      "url": "xyz789",
      "userName": "abc123",
      "webhookEvents": [WebhookEvent]
    }
  }
}
Mutations

deleteAddress

Description

delete address

Response

Returns an Address

Arguments
Name Description
id - ID ID of the address

Example

Query
mutation DeleteAddress($id: ID) {
  deleteAddress(id: $id) {
    addressLine1
    addressLine2
    city
    company
    country
    description
    email
    firstName
    id
    lastName
    phone
    postalCode
    state
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteAddress": {
      "addressLine1": "xyz789",
      "addressLine2": "xyz789",
      "city": "xyz789",
      "company": "abc123",
      "country": "abc123",
      "description": "abc123",
      "email": "abc123",
      "firstName": "xyz789",
      "id": 4,
      "lastName": "xyz789",
      "phone": "abc123",
      "postalCode": "xyz789",
      "state": "abc123"
    }
  }
}
Mutations

deleteCart

Description

Delete 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
mutation DeleteCart(
  $id: ID,
  $urlkey: String
) {
  deleteCart(
    id: $id,
    urlkey: $urlkey
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{"id": 4, "urlkey": "abc123"}
Response
{
  "data": {
    "deleteCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "guestId": 4,
      "id": 4,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "isPrivate": true,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": 4,
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}
Mutations

deleteCartLabelValue

Description

Delete cart label value

Response

Returns a CartLabelValue

Arguments
Name Description
id - ID Cart label value id

Example

Query
mutation DeleteCartLabelValue($id: ID) {
  deleteCartLabelValue(id: $id) {
    cartId
    id
    labelId
    orderId
    value
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteCartLabelValue": {
      "cartId": 4,
      "id": "4",
      "labelId": 4,
      "orderId": "4",
      "value": "xyz789"
    }
  }
}
Mutations

deleteCartProductLabelValue

Description

Delete cart product label value

Response

Returns a CartProductLabelValue

Arguments
Name Description
id - ID Cart product label value id

Example

Query
mutation DeleteCartProductLabelValue($id: ID) {
  deleteCartProductLabelValue(id: $id) {
    cartId
    id
    labelId
    orderId
    productId
    value
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteCartProductLabelValue": {
      "cartId": 4,
      "id": 4,
      "labelId": "4",
      "orderId": "4",
      "productId": 4,
      "value": "abc123"
    }
  }
}
Mutations

deleteCarts

Description

Delete cart/s

Response

Returns an ActionResult

Arguments
Name Description
id - IdFilter ID of the Cart/s

Example

Query
mutation DeleteCarts($id: IdFilter) {
  deleteCarts(id: $id) {
    message
    success
  }
}
Variables
{"id": IdFilter}
Response
{
  "data": {
    "deleteCarts": {
      "message": "xyz789",
      "success": false
    }
  }
}
Mutations

deleteContact

Description

delete contact

Response

Returns a String

Arguments
Name Description
contactId - ID id of the contact to be deleted

Example

Query
mutation DeleteContact($contactId: ID) {
  deleteContact(contactId: $contactId)
}
Variables
{"contactId": "4"}
Response
{"data": {"deleteContact": "abc123"}}
Mutations

deleteContactAddress

Description

delete contact address

Response

Returns a ContactAddress

Arguments
Name Description
contactAddressId - ID Contact address id

Example

Query
mutation DeleteContactAddress($contactAddressId: ID) {
  deleteContactAddress(contactAddressId: $contactAddressId) {
    address {
      ...AddressFragment
    }
    addressId
    contactId
    id
  }
}
Variables
{"contactAddressId": 4}
Response
{
  "data": {
    "deleteContactAddress": {
      "address": Address,
      "addressId": "4",
      "contactId": "4",
      "id": "4"
    }
  }
}
Mutations

deleteContactLabelValue

Description

Delete contact label value

Response

Returns a ContactLabelValue

Arguments
Name Description
id - ID Contact label value id

Example

Query
mutation DeleteContactLabelValue($id: ID) {
  deleteContactLabelValue(id: $id) {
    contactId
    id
    labelId
    value
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteContactLabelValue": {
      "contactId": "4",
      "id": 4,
      "labelId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

deleteContacts

Description

delete contacts

Response

Returns an ActionResult

Arguments
Name Description
id - IdFilter id/s of the contact to be deleted

Example

Query
mutation DeleteContacts($id: IdFilter) {
  deleteContacts(id: $id) {
    message
    success
  }
}
Variables
{"id": IdFilter}
Response
{
  "data": {
    "deleteContacts": {
      "message": "xyz789",
      "success": false
    }
  }
}
Mutations

deleteDiscounts

Description

Delete discounts.

Response

Returns [Discount]

Arguments
Name Description
id - IdFilter Id filter

Example

Query
mutation DeleteDiscounts($id: IdFilter) {
  deleteDiscounts(id: $id) {
    active
    applications
    fixedAmountValue
    id
    name
    ownerId
    percentageValue
    quantityOrAmount
    status
    type
    urlkey
    xgetyItems
    xgetyMinimumAmount
    xgetyMinimumQtyItems
    xgetyPercentage
  }
}
Variables
{"id": IdFilter}
Response
{
  "data": {
    "deleteDiscounts": [
      {
        "active": true,
        "applications": 123,
        "fixedAmountValue": 123.45,
        "id": 4,
        "name": "abc123",
        "ownerId": "4",
        "percentageValue": 123.45,
        "quantityOrAmount": 987,
        "status": false,
        "type": 987,
        "urlkey": "4",
        "xgetyItems": "abc123",
        "xgetyMinimumAmount": 987.65,
        "xgetyMinimumQtyItems": 987.65,
        "xgetyPercentage": 987.65
      }
    ]
  }
}
Mutations

deleteDrop

Description

delete a Drop by ID

Response

Returns a Drop

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

Example

Query
mutation DeleteDrop(
  $id: ID,
  $urlkey: String
) {
  deleteDrop(
    id: $id,
    urlkey: $urlkey
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "abc123"
}
Response
{
  "data": {
    "deleteDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 123,
      "archive": true,
      "asset": "abc123",
      "assets": ["xyz789"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "abc123",
      "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": "abc123",
      "info": "abc123",
      "isPublic": true,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "abc123",
      "note": "xyz789",
      "openrate": 123,
      "order": 987,
      "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": 987,
      "rangeDropInt": "xyz789",
      "rangeDropText": "abc123",
      "season": "xyz789",
      "sharedWithAll": true,
      "status": 987,
      "supplier": Contact,
      "supplierName": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

deleteDropLabelValue

Description

Delete drop label value

Response

Returns a DropLabelValue

Arguments
Name Description
id - ID drop label value id

Example

Query
mutation DeleteDropLabelValue($id: ID) {
  deleteDropLabelValue(id: $id) {
    dropId
    id
    labelId
    value
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteDropLabelValue": {
      "dropId": 4,
      "id": 4,
      "labelId": "4",
      "value": "xyz789"
    }
  }
}
Mutations

deleteDropPermission

Description

Delete a drop permission. (or unshare a drop)

Response

Returns a DropPermission

Arguments
Name Description
dropPermissionId - ID ID of the drop permission to remove

Example

Query
mutation DeleteDropPermission($dropPermissionId: ID) {
  deleteDropPermission(dropPermissionId: $dropPermissionId) {
    dropId
    id
    targetContact {
      ...ContactFragment
    }
    targetContactId
    targetUserGroup {
      ...UserGroupFragment
    }
    targetUserGroupId
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{"dropPermissionId": 4}
Response
{
  "data": {
    "deleteDropPermission": {
      "dropId": 4,
      "id": 4,
      "targetContact": Contact,
      "targetContactId": "4",
      "targetUserGroup": UserGroup,
      "targetUserGroupId": "4",
      "teamGroup": TeamGroup,
      "teamGroupId": "4",
      "teamUser": TeamUser,
      "teamUserId": 4
    }
  }
}
Mutations

deleteDrops

Description

delete drops

Response

Returns an ActionResult

Arguments
Name Description
id - IdFilter ID filter

Example

Query
mutation DeleteDrops($id: IdFilter) {
  deleteDrops(id: $id) {
    message
    success
  }
}
Variables
{"id": IdFilter}
Response
{
  "data": {
    "deleteDrops": {
      "message": "xyz789",
      "success": false
    }
  }
}
Mutations

deleteExternalProduct

Description

delete external products (and variants)

Response

Returns an Int

Arguments
Name Description
partnerIntegrationId - ID partner integration id
productId - ID product id

Example

Query
mutation DeleteExternalProduct(
  $partnerIntegrationId: ID,
  $productId: ID
) {
  deleteExternalProduct(
    partnerIntegrationId: $partnerIntegrationId,
    productId: $productId
  )
}
Variables
{
  "partnerIntegrationId": 4,
  "productId": "4"
}
Response
{"data": {"deleteExternalProduct": 987}}
Mutations

deleteIntegration

Description

Removes integration by id

Response

Returns a Boolean

Arguments
Name Description
id - ID Integration id

Example

Query
mutation DeleteIntegration($id: ID) {
  deleteIntegration(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteIntegration": false}}
Mutations

deleteIntegrationConfiguration

Description

Mutation for deleting a integration_configuration

Response

Returns an IntegrationConfiguration

Arguments
Name Description
integrationConfigurationId - ID! id of integration_configuration to update

Example

Query
mutation DeleteIntegrationConfiguration($integrationConfigurationId: ID!) {
  deleteIntegrationConfiguration(integrationConfigurationId: $integrationConfigurationId) {
    id
    key
    partnerIntegrationId
    value
  }
}
Variables
{"integrationConfigurationId": "4"}
Response
{
  "data": {
    "deleteIntegrationConfiguration": {
      "id": "4",
      "key": "abc123",
      "partnerIntegrationId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

deleteLabel

Description

delete label

Response

Returns a Label

Arguments
Name Description
id - ID

Example

Query
mutation DeleteLabel($id: ID) {
  deleteLabel(id: $id) {
    id
    name
    objectType
    objectTypes
    public
    selectOptions
    type
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteLabel": {
      "id": 4,
      "name": "xyz789",
      "objectType": "abc123",
      "objectTypes": ["abc123"],
      "public": true,
      "selectOptions": ["xyz789"],
      "type": "abc123"
    }
  }
}
Mutations

deleteOrder

Description

delete 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
mutation DeleteOrder(
  $id: ID,
  $urlkey: String
) {
  deleteOrder(
    id: $id,
    urlkey: $urlkey
  ) {
    appliedDiscountId
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "deleteOrder": {
      "appliedDiscountId": "4",
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "buyerName": "abc123",
      "cancel": true,
      "cartComment": "abc123",
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customDiscount": "abc123",
      "customId": "xyz789",
      "discountAmount": 987.65,
      "discountType": "xyz789",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 123.45,
      "id": 4,
      "inform": false,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "invoiceDate": "2007-12-03",
      "invoiceNo": "xyz789",
      "isSeller": false,
      "labelsData": Json,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": "4",
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 123.45,
      "rangeOrderInt": "abc123",
      "rangeOrderText": "abc123",
      "rating": 123,
      "rep": User,
      "repCredential": Cred,
      "repCredentialId": 4,
      "repId": "4",
      "rows": [OrderRow],
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": 4,
      "shippingCosts": 987.65,
      "showTeamMemberSalesRep": true,
      "status": false,
      "sumOfProducts": 987.65,
      "supplierName": "abc123",
      "totalAmount": 123.45,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "vat": 123.45
    }
  }
}
Mutations

deleteOrderExtraCost

Response

Returns an OrderExtraCost

Arguments
Name Description
id - ID! ID of the order extra cost

Example

Query
mutation DeleteOrderExtraCost($id: ID!) {
  deleteOrderExtraCost(id: $id) {
    amount
    id
    name
    taxRatio
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteOrderExtraCost": {
      "amount": 123.45,
      "id": "4",
      "name": "abc123",
      "taxRatio": 123.45
    }
  }
}
Mutations

deleteOrders

Description

delete orders

Response

Returns an ActionResult

Arguments
Name Description
id - IdFilter ID filter

Example

Query
mutation DeleteOrders($id: IdFilter) {
  deleteOrders(id: $id) {
    message
    success
  }
}
Variables
{"id": IdFilter}
Response
{
  "data": {
    "deleteOrders": {
      "message": "xyz789",
      "success": true
    }
  }
}
Mutations

deletePaymentSubscription

Description

Delete paymentSubscription.

Response

Returns a PaymentSubscription

Arguments
Name Description
id - ID

Example

Query
mutation DeletePaymentSubscription($id: ID) {
  deletePaymentSubscription(id: $id) {
    id
    stripeCustomerId
    stripePlanName
    stripeProductId
    stripeSubscriptionId
    stripeSubscriptionStatus
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deletePaymentSubscription": {
      "id": "4",
      "stripeCustomerId": "xyz789",
      "stripePlanName": "xyz789",
      "stripeProductId": "abc123",
      "stripeSubscriptionId": "abc123",
      "stripeSubscriptionStatus": "xyz789"
    }
  }
}
Mutations

deletePriceContact

Description

Delete price contact.

Response

Returns a PriceContact

Arguments
Name Description
id - ID Price contact id

Example

Query
mutation DeletePriceContact($id: ID) {
  deletePriceContact(id: $id) {
    contactId
    id
    priceId
    userGroupId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deletePriceContact": {
      "contactId": 4,
      "id": "4",
      "priceId": "4",
      "userGroupId": "4"
    }
  }
}
Mutations

deletePricelistValue

Description

Delete pricelist value

Response

Returns a PricelistValue

Arguments
Name Description
id - ID! Pricelist value id

Example

Query
mutation DeletePricelistValue($id: ID!) {
  deletePricelistValue(id: $id) {
    currency
    id
    priceContacts {
      ...PriceContactFragment
    }
    prices {
      ...PriceFragment
    }
    product {
      ...ProductFragment
    }
    productId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deletePricelistValue": {
      "currency": "abc123",
      "id": 4,
      "priceContacts": [PriceContact],
      "prices": [Price],
      "product": Product,
      "productId": "4"
    }
  }
}
Mutations

deleteProductLabelValue

Description

Delete product label value

Response

Returns a ProductLabelValue

Arguments
Name Description
id - ID product label value id

Example

Query
mutation DeleteProductLabelValue($id: ID) {
  deleteProductLabelValue(id: $id) {
    id
    labelId
    productId
    value
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteProductLabelValue": {
      "id": "4",
      "labelId": "4",
      "productId": "4",
      "value": "abc123"
    }
  }
}
Mutations

deleteProductVariants

Description

Delete product variants.

Response

Returns [ProductVariant]

Arguments
Name Description
ids - [ID] Product variant ids to delete

Example

Query
mutation DeleteProductVariants($ids: [ID]) {
  deleteProductVariants(ids: $ids) {
    color
    cost
    costCurrency
    createdAt
    currency
    customId
    id
    images
    inventoryStock
    optionValue1
    optionValue2
    optionValue3
    parent {
      ...ProductFragment
    }
    parentId
    price
    priceCurrency
    rowOrder
    rrp
    rrpCurrency
    sellWhenOos
    sku
    soldOut
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
  }
}
Variables
{"ids": ["4"]}
Response
{
  "data": {
    "deleteProductVariants": [
      {
        "color": "abc123",
        "cost": 123.45,
        "costCurrency": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customId": "abc123",
        "id": "4",
        "images": ["xyz789"],
        "inventoryStock": "abc123",
        "optionValue1": "abc123",
        "optionValue2": "xyz789",
        "optionValue3": "xyz789",
        "parent": Product,
        "parentId": "4",
        "price": 123.45,
        "priceCurrency": "xyz789",
        "rowOrder": 987,
        "rrp": "xyz789",
        "rrpCurrency": "xyz789",
        "sellWhenOos": false,
        "sku": "abc123",
        "soldOut": true,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "variantCustomField1": "xyz789",
        "variantCustomField2": "xyz789",
        "variantCustomField3": "xyz789"
      }
    ]
  }
}
Mutations

deleteProducts

Description

Delete products.

Response

Returns [Product]

Arguments
Name Description
id - IdFilter Id filter

Example

Query
mutation DeleteProducts($id: IdFilter) {
  deleteProducts(id: $id) {
    color
    cost
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{"id": IdFilter}
Response
{
  "data": {
    "deleteProducts": [
      {
        "color": "xyz789",
        "cost": 987.65,
        "costCurrency": "xyz789",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customField1": "abc123",
        "customField2": "abc123",
        "customField3": "abc123",
        "customField4": "abc123",
        "customField5": "xyz789",
        "customField6": "xyz789",
        "customField7": "abc123",
        "customField8": "xyz789",
        "customId": "xyz789",
        "customIdInt": "abc123",
        "customIdText": "abc123",
        "ean": "abc123",
        "externalProducts": [ExternalProduct],
        "id": 4,
        "images": ["xyz789"],
        "img": "xyz789",
        "info": "abc123",
        "inventoryStock": "abc123",
        "inventoryStockLimit": "abc123",
        "material": "xyz789",
        "name": "abc123",
        "optionGroups": [ProductOptionGroup],
        "optionValue1": "xyz789",
        "optionValue2": "xyz789",
        "optionValue3": "xyz789",
        "origin": "abc123",
        "owner": User,
        "ownerId": "abc123",
        "parent": Product,
        "parentId": 4,
        "parentOrChild": "xyz789",
        "price": 123.45,
        "productUserGroups": [ProductUserGroup],
        "rangeProductInt": "abc123",
        "rangeProductText": "xyz789",
        "rowOrder": 987,
        "rrp": "xyz789",
        "sku": "abc123",
        "soldOut": false,
        "source": "xyz789",
        "supplier": Contact,
        "supplierId": "4",
        "supplierName": "xyz789",
        "taric": "xyz789",
        "type": "abc123",
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "variantCustomField1": "xyz789",
        "variantCustomField2": "xyz789",
        "variantCustomField3": "xyz789",
        "variants": [Product],
        "variantsV2": [ProductVariant]
      }
    ]
  }
}
Mutations

deleteTeamGroup

Description

Delete a team group

Response

Returns a TeamGroup

Arguments
Name Description
id - ID! ID of the team group to delete

Example

Query
mutation DeleteTeamGroup($id: ID!) {
  deleteTeamGroup(id: $id) {
    id
    members {
      ...TeamGroupMemberFragment
    }
    name
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteTeamGroup": {
      "id": "4",
      "members": [TeamGroupMember],
      "name": "abc123"
    }
  }
}
Mutations

deleteTeamUser

Description

Delete teamUser

Response

Returns a TeamUser

Arguments
Name Description
id - ID

Example

Query
mutation DeleteTeamUser($id: ID) {
  deleteTeamUser(id: $id) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteTeamUser": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": true,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": 4,
      "id": "4",
      "role": "xyz789",
      "userId": "4"
    }
  }
}
Mutations

deleteUserGroup

Description

Delete userGroup

Response

Returns a UserGroup

Arguments
Name Description
id - ID

Example

Query
mutation DeleteUserGroup($id: ID) {
  deleteUserGroup(id: $id) {
    id
    members {
      ...UserGroupMemberFragment
    }
    name
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteUserGroup": {
      "id": "4",
      "members": [UserGroupMember],
      "name": "xyz789"
    }
  }
}
Mutations

deleteWebhook

Response

Returns a Webhook

Arguments
Name Description
id - ID! webhook id

Example

Query
mutation DeleteWebhook($id: ID!) {
  deleteWebhook(id: $id) {
    headers
    id
    owner {
      ...UserFragment
    }
    ownerId
    password
    url
    userName
    webhookEvents {
      ...WebhookEventFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "deleteWebhook": {
      "headers": Json,
      "id": "4",
      "owner": User,
      "ownerId": 4,
      "password": "abc123",
      "url": "xyz789",
      "userName": "xyz789",
      "webhookEvents": [WebhookEvent]
    }
  }
}
Mutations

deleteWebhookEvent

Response

Returns a WebhookEvent

Arguments
Name Description
id - ID! webhook event id

Example

Query
mutation DeleteWebhookEvent($id: ID!) {
  deleteWebhookEvent(id: $id) {
    eventType
    id
    objectType
    webhookId
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "deleteWebhookEvent": {
      "eventType": "xyz789",
      "id": "4",
      "objectType": "abc123",
      "webhookId": "4"
    }
  }
}
Mutations

downloadContacts

Description

download contacts

Response

Returns a String

Arguments
Name Description
type - String excel or csv. Default = "excel"

Example

Query
mutation DownloadContacts($type: String) {
  downloadContacts(type: $type)
}
Variables
{"type": "excel"}
Response
{"data": {"downloadContacts": "abc123"}}
Mutations

duplicateCart

Description

Duplicate (copy) 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
mutation DuplicateCart(
  $id: ID,
  $urlkey: String
) {
  duplicateCart(
    id: $id,
    urlkey: $urlkey
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "abc123"
}
Response
{
  "data": {
    "duplicateCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "guestId": 4,
      "id": 4,
      "invoiceAddress": Address,
      "invoiceAddressId": 4,
      "isPrivate": true,
      "ownerId": "4",
      "parentProducts": [CartProduct],
      "repId": 4,
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

duplicateDrop

Response

Returns a Drop

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

Example

Query
mutation DuplicateDrop(
  $id: ID,
  $urlkey: String
) {
  duplicateDrop(
    id: $id,
    urlkey: $urlkey
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{
  "id": "4",
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "duplicateDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 123,
      "archive": true,
      "asset": "abc123",
      "assets": ["xyz789"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "xyz789",
      "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": [123],
      "id": 4,
      "images": ["xyz789"],
      "img": "xyz789",
      "info": "abc123",
      "isPublic": false,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "note": "xyz789",
      "openrate": 987,
      "order": 987,
      "orderItemsQty": 123.45,
      "orderQty": 987,
      "orderTotal": 987.65,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "abc123",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "abc123",
      "public": false,
      "publicVisitorCount": 123,
      "rangeDropInt": "xyz789",
      "rangeDropText": "abc123",
      "season": "abc123",
      "sharedWithAll": true,
      "status": 123,
      "supplier": Contact,
      "supplierName": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

duplicateProduct

Description

Duplicate product (and update the duplicated product.)

Response

Returns a Product

Arguments
Name Description
data - UpdateProductInput! Data for updating the duplicated product
id - ID Product id

Example

Query
mutation DuplicateProduct(
  $data: UpdateProductInput!,
  $id: ID
) {
  duplicateProduct(
    data: $data,
    id: $id
  ) {
    color
    cost
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{
  "data": UpdateProductInput,
  "id": "4"
}
Response
{
  "data": {
    "duplicateProduct": {
      "color": "abc123",
      "cost": 987.65,
      "costCurrency": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customField1": "abc123",
      "customField2": "xyz789",
      "customField3": "abc123",
      "customField4": "abc123",
      "customField5": "xyz789",
      "customField6": "abc123",
      "customField7": "abc123",
      "customField8": "xyz789",
      "customId": "abc123",
      "customIdInt": "xyz789",
      "customIdText": "abc123",
      "ean": "abc123",
      "externalProducts": [ExternalProduct],
      "id": 4,
      "images": ["xyz789"],
      "img": "xyz789",
      "info": "xyz789",
      "inventoryStock": "abc123",
      "inventoryStockLimit": "xyz789",
      "material": "xyz789",
      "name": "abc123",
      "optionGroups": [ProductOptionGroup],
      "optionValue1": "abc123",
      "optionValue2": "abc123",
      "optionValue3": "abc123",
      "origin": "abc123",
      "owner": User,
      "ownerId": "abc123",
      "parent": Product,
      "parentId": 4,
      "parentOrChild": "xyz789",
      "price": 987.65,
      "productUserGroups": [ProductUserGroup],
      "rangeProductInt": "abc123",
      "rangeProductText": "xyz789",
      "rowOrder": 987,
      "rrp": "xyz789",
      "sku": "abc123",
      "soldOut": true,
      "source": "abc123",
      "supplier": Contact,
      "supplierId": 4,
      "supplierName": "xyz789",
      "taric": "xyz789",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "variantCustomField1": "abc123",
      "variantCustomField2": "xyz789",
      "variantCustomField3": "abc123",
      "variants": [Product],
      "variantsV2": [ProductVariant]
    }
  }
}
Mutations

emailLogin

Description

Initiate passwordless login by sending a code via email

Response

Returns an EmailLoginConfirmation

Arguments
Name Description
email - String! Email of the user
options - LoginOptions Additional information to be provided with the login. Default = {countryCode: ""}

Example

Query
mutation EmailLogin(
  $email: String!,
  $options: LoginOptions
) {
  emailLogin(
    email: $email,
    options: $options
  ) {
    id
    urlkey
  }
}
Variables
{
  "email": "xyz789",
  "options": {"countryCode": ""}
}
Response
{
  "data": {
    "emailLogin": {
      "id": "4",
      "urlkey": "abc123"
    }
  }
}
Mutations

emailLoginConfirm

Description

Confirm email login with the code received via email

Response

Returns a Session

Arguments
Name Description
input - EmailLoginConfirmInput Fields required for confirming email login

Example

Query
mutation EmailLoginConfirm($input: EmailLoginConfirmInput) {
  emailLoginConfirm(input: $input) {
    id
    user {
      ...UserFragment
    }
  }
}
Variables
{"input": EmailLoginConfirmInput}
Response
{
  "data": {
    "emailLoginConfirm": {
      "id": "4",
      "user": User
    }
  }
}
Mutations

exportContactAddresses

Description

Export contact addresses

Response

Returns a BackgroundJob

Arguments
Name Description
type - SpreadsheetType Default = EXCEL

Example

Query
mutation ExportContactAddresses($type: SpreadsheetType) {
  exportContactAddresses(type: $type) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"type": "EXCEL"}
Response
{
  "data": {
    "exportContactAddresses": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

exportPrices

Description

Export prices.

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID drop_id for a list of products
productIds - [ID] product ids for a list of products
type - SpreadsheetType Default = EXCEL

Example

Query
mutation ExportPrices(
  $dropId: ID,
  $productIds: [ID],
  $type: SpreadsheetType
) {
  exportPrices(
    dropId: $dropId,
    productIds: $productIds,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "dropId": "4",
  "productIds": ["4"],
  "type": "EXCEL"
}
Response
{
  "data": {
    "exportPrices": {
      "cartId": 4,
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": 4,
      "orderId": "4",
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

exportProductVariants

Description

Export (drop) products spreadsheet

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation ExportProductVariants(
  $dropId: ID!,
  $type: SpreadsheetType
) {
  exportProductVariants(
    dropId: $dropId,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"dropId": 4, "type": "EXCEL"}
Response
{
  "data": {
    "exportProductVariants": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

exportProducts

Description

Export (drop) products spreadsheet

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation ExportProducts(
  $id: ID!,
  $type: SpreadsheetType
) {
  exportProducts(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "exportProducts": {
      "cartId": 4,
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": 4,
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

exportShopifyProductsSpreadsheet

Description

Export shopify products spreadsheet.

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID drop_id for a list of products
orderId - ID order_id for a list of products
type - SpreadsheetType Default = EXCEL

Example

Query
mutation ExportShopifyProductsSpreadsheet(
  $dropId: ID,
  $orderId: ID,
  $type: SpreadsheetType
) {
  exportShopifyProductsSpreadsheet(
    dropId: $dropId,
    orderId: $orderId,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"dropId": 4, "orderId": 4, "type": "EXCEL"}
Response
{
  "data": {
    "exportShopifyProductsSpreadsheet": {
      "cartId": "4",
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": 4,
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

generateAssetArchive

Description

generate asset archive

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID drop id

Example

Query
mutation GenerateAssetArchive($dropId: ID) {
  generateAssetArchive(dropId: $dropId) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"dropId": 4}
Response
{
  "data": {
    "generateAssetArchive": {
      "cartId": "4",
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": "4",
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

generateCartPdf

Description

generate cart pdf

Response

Returns a BackgroundJob

Arguments
Name Description
cartId - ID cart id
templateType - TemplateType Template type

Example

Query
mutation GenerateCartPdf(
  $cartId: ID,
  $templateType: TemplateType
) {
  generateCartPdf(
    cartId: $cartId,
    templateType: $templateType
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "cartId": "4",
  "templateType": "BIG_IMAGES"
}
Response
{
  "data": {
    "generateCartPdf": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

generateContactsSpreadsheet

Description

Start contact download file generation

Response

Returns a BackgroundJob

Arguments
Name Description
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateContactsSpreadsheet($type: SpreadsheetType) {
  generateContactsSpreadsheet(type: $type) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"type": "EXCEL"}
Response
{
  "data": {
    "generateContactsSpreadsheet": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

generateDropOrdersOverviewSpreadsheet

Description

starts the bg job for creating orders_overview_speradsheet. returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateDropOrdersOverviewSpreadsheet(
  $id: ID,
  $type: SpreadsheetType
) {
  generateDropOrdersOverviewSpreadsheet(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "generateDropOrdersOverviewSpreadsheet": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

generateDropOrdersSpreadsheet

Description

starts the bg job for creating orders_speradsheet. returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
func - String Default = "generate_data"
id - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateDropOrdersSpreadsheet(
  $func: String,
  $id: ID!,
  $type: SpreadsheetType
) {
  generateDropOrdersSpreadsheet(
    func: $func,
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"func": "generate_data", "id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "generateDropOrdersSpreadsheet": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

generateDropPdf

Description

generate drop pdf

Response

Returns a BackgroundJob

Arguments
Name Description
contactId - ID contact id
dropId - ID drop id

Example

Query
mutation GenerateDropPdf(
  $contactId: ID,
  $dropId: ID
) {
  generateDropPdf(
    contactId: $contactId,
    dropId: $dropId
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"contactId": "4", "dropId": 4}
Response
{
  "data": {
    "generateDropPdf": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

generateDropProductsImagesZip

Description

starts the bg job for generating the drop products images zip file. returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the Drop

Example

Query
mutation GenerateDropProductsImagesZip($id: ID!) {
  generateDropProductsImagesZip(id: $id) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "generateDropProductsImagesZip": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

generateDropProductsSpreadsheet

Description

starts the bg job for creating drop_products_speradsheet. returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateDropProductsSpreadsheet(
  $id: ID!,
  $type: SpreadsheetType
) {
  generateDropProductsSpreadsheet(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "generateDropProductsSpreadsheet": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

generateDropSupplierCartSpreadsheet

Description

starts the bg job for creating supplier_cart_speradsheet. returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateDropSupplierCartSpreadsheet(
  $id: ID!,
  $type: SpreadsheetType
) {
  generateDropSupplierCartSpreadsheet(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "generateDropSupplierCartSpreadsheet": {
      "cartId": 4,
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": "4",
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

generateDropSupplierOrderSpreadsheet

Description

starts the bg job for creating supplier_order_speradsheet. returns the related job id

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateDropSupplierOrderSpreadsheet(
  $id: ID!,
  $type: SpreadsheetType
) {
  generateDropSupplierOrderSpreadsheet(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "generateDropSupplierOrderSpreadsheet": {
      "cartId": "4",
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": 4,
      "orderId": "4",
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

generateGuestId

Description

Generates a guest user identifier

Response

Returns a Token

Example

Query
mutation GenerateGuestId {
  generateGuestId {
    comment
    id
    isValid
    ownerId
    type
    userId
    value
  }
}
Response
{
  "data": {
    "generateGuestId": {
      "comment": "xyz789",
      "id": 4,
      "isValid": false,
      "ownerId": "4",
      "type": "xyz789",
      "userId": 123,
      "value": "abc123"
    }
  }
}
Mutations

generateInvoice

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the order
type - OrderPdfs Default = INVOICE

Example

Query
mutation GenerateInvoice(
  $id: ID!,
  $type: OrderPdfs
) {
  generateInvoice(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "INVOICE"}
Response
{
  "data": {
    "generateInvoice": {
      "cartId": 4,
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": "4",
      "orderId": "4",
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

generateInvoiceSpreadsheet

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the order

Example

Query
mutation GenerateInvoiceSpreadsheet($id: ID!) {
  generateInvoiceSpreadsheet(id: $id) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "generateInvoiceSpreadsheet": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

generateLongLivedToken

Description

generate integration token and save it to integrations table

Response

Returns a Token

Example

Query
mutation GenerateLongLivedToken {
  generateLongLivedToken {
    comment
    id
    isValid
    ownerId
    type
    userId
    value
  }
}
Response
{
  "data": {
    "generateLongLivedToken": {
      "comment": "xyz789",
      "id": 4,
      "isValid": true,
      "ownerId": 4,
      "type": "xyz789",
      "userId": 987,
      "value": "abc123"
    }
  }
}
Mutations

generateOrderConfirmationPdf

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the order

Example

Query
mutation GenerateOrderConfirmationPdf($id: ID!) {
  generateOrderConfirmationPdf(id: $id) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "generateOrderConfirmationPdf": {
      "cartId": "4",
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": "4",
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

generateOrderConfirmationSpreadsheet

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the order
type - SpreadsheetType Default = EXCEL

Example

Query
mutation GenerateOrderConfirmationSpreadsheet(
  $id: ID!,
  $type: SpreadsheetType
) {
  generateOrderConfirmationSpreadsheet(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
  "data": {
    "generateOrderConfirmationSpreadsheet": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

generatePresignedPut

Description

Get a direct file upload URL to be used to do a PUT request with file content

Response

Returns a PresignedPut

Arguments
Name Description
fileName - String Name of file to be uploaded

Example

Query
mutation GeneratePresignedPut($fileName: String) {
  generatePresignedPut(fileName: $fileName) {
    url
  }
}
Variables
{"fileName": "abc123"}
Response
{
  "data": {
    "generatePresignedPut": {
      "url": "xyz789"
    }
  }
}
Mutations

horizontalOrdersSpreadsheet

Description

Export horizontal orders spreadsheet

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the Drop
type - SpreadsheetType Default = EXCEL

Example

Query
mutation HorizontalOrdersSpreadsheet(
  $id: ID!,
  $type: SpreadsheetType
) {
  horizontalOrdersSpreadsheet(
    id: $id,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": "4", "type": "EXCEL"}
Response
{
  "data": {
    "horizontalOrdersSpreadsheet": {
      "cartId": 4,
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": "4",
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": "4",
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

importContactAddresses

Description

Import of contact addresses.

Response

Returns a BackgroundJob

Arguments
Name Description
fileUrl - String! Excel or csv file url to import

Example

Query
mutation ImportContactAddresses($fileUrl: String!) {
  importContactAddresses(fileUrl: $fileUrl) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"fileUrl": "abc123"}
Response
{
  "data": {
    "importContactAddresses": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

importContacts

Description

Start import of contacts.

Response

Returns a BackgroundJob

Arguments
Name Description
fileUrl - String! Excel or csv file url to import

Example

Query
mutation ImportContacts($fileUrl: String!) {
  importContacts(fileUrl: $fileUrl) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"fileUrl": "abc123"}
Response
{
  "data": {
    "importContacts": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

importPrices

Description

import prices.

Response

Returns a BackgroundJob

Arguments
Name Description
fileUrl - String! Excel or csv file url to import

Example

Query
mutation ImportPrices($fileUrl: String!) {
  importPrices(fileUrl: $fileUrl) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"fileUrl": "xyz789"}
Response
{
  "data": {
    "importPrices": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

importProductVariants

Description

Start import of products.

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID optional drop_id
fileUrl - String! Excel or csv file url to import

Example

Query
mutation ImportProductVariants(
  $dropId: ID,
  $fileUrl: String!
) {
  importProductVariants(
    dropId: $dropId,
    fileUrl: $fileUrl
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"dropId": 4, "fileUrl": "abc123"}
Response
{
  "data": {
    "importProductVariants": {
      "cartId": 4,
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": "4",
      "id": 4,
      "orderId": 4,
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

importProductVariantsSampleFile

Description

import product variants sample file.

Response

Returns an Url

Example

Query
mutation ImportProductVariantsSampleFile {
  importProductVariantsSampleFile {
    url
  }
}
Response
{
  "data": {
    "importProductVariantsSampleFile": {
      "url": "xyz789"
    }
  }
}
Mutations

importProducts

Description

Start import of products.

Response

Returns a BackgroundJob

Arguments
Name Description
dropId - ID optional drop_id
fileUrl - String! Excel or csv file url to import

Example

Query
mutation ImportProducts(
  $dropId: ID,
  $fileUrl: String!
) {
  importProducts(
    dropId: $dropId,
    fileUrl: $fileUrl
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "dropId": "4",
  "fileUrl": "abc123"
}
Response
{
  "data": {
    "importProducts": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

integrationToggleIsActive

Description

shopify toggle is_active

Response

Returns a ShopifyIntegrationData

Arguments
Name Description
id - ID! partner_integration_id

Example

Query
mutation IntegrationToggleIsActive($id: ID!) {
  integrationToggleIsActive(id: $id) {
    isActive
    orderFinancialStatus
    orderSyncStatus
    productsSynced
    syncActiveInventory
    syncCostAsPrice
    syncDraftInventory
    syncOrderUpdates
    syncOrders
    syncPriceAndRrp
    webhooksActivated
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "integrationToggleIsActive": {
      "isActive": true,
      "orderFinancialStatus": "xyz789",
      "orderSyncStatus": "xyz789",
      "productsSynced": true,
      "syncActiveInventory": false,
      "syncCostAsPrice": false,
      "syncDraftInventory": false,
      "syncOrderUpdates": false,
      "syncOrders": false,
      "syncPriceAndRrp": true,
      "webhooksActivated": false
    }
  }
}
Mutations

integrationToken

Description

Generate/retrieve integration token

Response

Returns a String

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

Example

Query
mutation IntegrationToken($userId: ID) {
  integrationToken(userId: $userId)
}
Variables
{"userId": 4}
Response
{"data": {"integrationToken": "abc123"}}
Mutations

invalidateToken

Description

Invalidate token

Response

Returns a String

Example

Query
mutation InvalidateToken {
  invalidateToken
}
Response
{"data": {"invalidateToken": "abc123"}}
Mutations

inviteContact

Description

Invite contact (or send connect request).

Response

Returns a Contact

Arguments
Name Description
id - ID id of the contact to be invited.

Example

Query
mutation InviteContact($id: ID) {
  inviteContact(id: $id) {
    accessCustomers {
      ...AccessContactFragment
    }
    accessSuppliers {
      ...AccessContactFragment
    }
    address {
      ...AddressFragment
    }
    addressId
    blockOrdering
    contactUser {
      ...UserFragment
    }
    contactUserId
    currency
    customId
    defaultSupplier
    discount
    email
    emailEditable
    id
    img
    invite
    invoiceAddress
    invoiceApartment
    invoiceCity
    invoiceCompany
    invoiceCountry
    invoiceFirstname
    invoiceLastname
    invoicePostalcode
    invoiceRegion
    isSuperman
    isSuperwoman
    lastInvite
    listAddresses {
      ...ContactAddressFragment
    }
    migrateOldId
    name
    notes
    ownerId
    paymentBankCustom
    paymentEmail
    paymentIbanCustom
    paymentMethod
    paymentTaxCode
    paymentVatCustom
    phone
    shippingAddr {
      ...AddressFragment
    }
    shippingAddress
    shippingAddressId
    shippingApartment
    shippingCity
    shippingCompany
    shippingCountry
    shippingFirstname
    shippingLastname
    shippingPostalcode
    shippingRegion
    showConnectButton
    showPaymentTaxCode
    status
    taxRatio
    termOfPayment
    type
    urlkey
    userGroups {
      ...UserGroupFragment
    }
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "inviteContact": {
      "accessCustomers": [AccessContact],
      "accessSuppliers": [AccessContact],
      "address": Address,
      "addressId": "4",
      "blockOrdering": true,
      "contactUser": User,
      "contactUserId": 4,
      "currency": "xyz789",
      "customId": "abc123",
      "defaultSupplier": 987,
      "discount": 123.45,
      "email": "abc123",
      "emailEditable": false,
      "id": "4",
      "img": ["abc123"],
      "invite": true,
      "invoiceAddress": "abc123",
      "invoiceApartment": "abc123",
      "invoiceCity": "abc123",
      "invoiceCompany": "xyz789",
      "invoiceCountry": "xyz789",
      "invoiceFirstname": "xyz789",
      "invoiceLastname": "abc123",
      "invoicePostalcode": "abc123",
      "invoiceRegion": "xyz789",
      "isSuperman": false,
      "isSuperwoman": false,
      "lastInvite": "2007-12-03T10:15:30Z",
      "listAddresses": [ContactAddress],
      "migrateOldId": "abc123",
      "name": "xyz789",
      "notes": "abc123",
      "ownerId": "4",
      "paymentBankCustom": "abc123",
      "paymentEmail": "xyz789",
      "paymentIbanCustom": "abc123",
      "paymentMethod": "xyz789",
      "paymentTaxCode": "xyz789",
      "paymentVatCustom": "abc123",
      "phone": "abc123",
      "shippingAddr": Address,
      "shippingAddress": "xyz789",
      "shippingAddressId": 4,
      "shippingApartment": "xyz789",
      "shippingCity": "abc123",
      "shippingCompany": "abc123",
      "shippingCountry": "abc123",
      "shippingFirstname": "abc123",
      "shippingLastname": "xyz789",
      "shippingPostalcode": "xyz789",
      "shippingRegion": "abc123",
      "showConnectButton": true,
      "showPaymentTaxCode": true,
      "status": 987,
      "taxRatio": 123.45,
      "termOfPayment": "xyz789",
      "type": 987,
      "urlkey": "xyz789",
      "userGroups": [UserGroup]
    }
  }
}
Mutations

login

Description

Authenticate with Order41

Response

Returns a String

Arguments
Name Description
email - String! Email of the user
options - LoginOptions Additional information to be provided with the login. Default = {countryCode: ""}
password - String! Password of the user

Example

Query
mutation Login(
  $email: String!,
  $options: LoginOptions,
  $password: String!
) {
  login(
    email: $email,
    options: $options,
    password: $password
  )
}
Variables
{
  "email": "xyz789",
  "options": {"countryCode": ""},
  "password": "abc123"
}
Response
{"data": {"login": "xyz789"}}
Mutations

loginAs

Description

Login as another user

Response

Returns a String

Arguments
Name Description
email - String! Email of the user

Example

Query
mutation LoginAs($email: String!) {
  loginAs(email: $email)
}
Variables
{"email": "xyz789"}
Response
{"data": {"loginAs": "xyz789"}}
Mutations

orderDrops

Description

order drops of user

Response

Returns a String

Arguments
Name Description
dropIds - [ID] drop ids

Example

Query
mutation OrderDrops($dropIds: [ID]) {
  orderDrops(dropIds: $dropIds)
}
Variables
{"dropIds": ["4"]}
Response
{"data": {"orderDrops": "xyz789"}}
Mutations

orderProductsImages

Response

Returns a BackgroundJob

Arguments
Name Description
id - ID! ID of the order

Example

Query
mutation OrderProductsImages($id: ID!) {
  orderProductsImages(id: $id) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "orderProductsImages": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

passwordResetEmail

Description

Send password reset email

Response

Returns a BackgroundJob

Arguments
Name Description
email - String! Email of the user

Example

Query
mutation PasswordResetEmail($email: String!) {
  passwordResetEmail(email: $email) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"email": "abc123"}
Response
{
  "data": {
    "passwordResetEmail": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

planChangeRequest

Description

Request for plan change

Response

Returns a PlanChangeRequest

Arguments
Name Description
planId - ID! Unique identifier of the plan

Example

Query
mutation PlanChangeRequest($planId: ID!) {
  planChangeRequest(planId: $planId) {
    acceptedAt
    acceptedBy
    id
    plan {
      ...PlanFragment
    }
    planId
    userId
  }
}
Variables
{"planId": "4"}
Response
{
  "data": {
    "planChangeRequest": {
      "acceptedAt": "2007-12-03T10:15:30Z",
      "acceptedBy": "4",
      "id": "4",
      "plan": Plan,
      "planId": "4",
      "userId": 4
    }
  }
}
Mutations

putExternalContacts

Description

put external contacts

Response

Returns a String

Arguments
Name Description
externalContacts - [ExternalContactInput] external contacts

Example

Query
mutation PutExternalContacts($externalContacts: [ExternalContactInput]) {
  putExternalContacts(externalContacts: $externalContacts)
}
Variables
{"externalContacts": [ExternalContactInput]}
Response
{"data": {"putExternalContacts": "abc123"}}
Mutations

putExternalOrders

Description

put external order ids

Response

Returns a String

Arguments
Name Description
externalOrders - [ExternalOrderInput] external orders

Example

Query
mutation PutExternalOrders($externalOrders: [ExternalOrderInput]) {
  putExternalOrders(externalOrders: $externalOrders)
}
Variables
{"externalOrders": [ExternalOrderInput]}
Response
{"data": {"putExternalOrders": "xyz789"}}
Mutations

putExternalProducts

Description

put external product ids

Response

Returns a String

Arguments
Name Description
externalProducts - [ExternalProductInput] external product ids

Example

Query
mutation PutExternalProducts($externalProducts: [ExternalProductInput]) {
  putExternalProducts(externalProducts: $externalProducts)
}
Variables
{"externalProducts": [ExternalProductInput]}
Response
{"data": {"putExternalProducts": "abc123"}}
Mutations

putIntegration

Description

put integration (creates or updates integration)

Response

Returns a String

Arguments
Name Description
data - IntegrationInput integration data

Example

Query
mutation PutIntegration($data: IntegrationInput) {
  putIntegration(data: $data)
}
Variables
{"data": IntegrationInput}
Response
{"data": {"putIntegration": "abc123"}}
Mutations

putIntegrationData

Description

put integration data

Response

Returns a String

Arguments
Name Description
keysValues - [IntegrationDataInput] list of key values
userId - ID if nouser token is used this is required

Example

Query
mutation PutIntegrationData(
  $keysValues: [IntegrationDataInput],
  $userId: ID
) {
  putIntegrationData(
    keysValues: $keysValues,
    userId: $userId
  )
}
Variables
{"keysValues": [IntegrationDataInput], "userId": 4}
Response
{"data": {"putIntegrationData": "xyz789"}}
Mutations

rateDrop

Description

Rate a drop.

Response

Returns a DropRate

Arguments
Name Description
id - ID! ID of the Drop
rate - Int Rate for the drop between 1 and 10 - inclusive

Example

Query
mutation RateDrop(
  $id: ID!,
  $rate: Int
) {
  rateDrop(
    id: $id,
    rate: $rate
  ) {
    dropId
    rate
  }
}
Variables
{"id": "4", "rate": 987}
Response
{
  "data": {
    "rateDrop": {"dropId": "4", "rate": 987}
  }
}
Mutations

rateOrder

Response

Returns an Order

Arguments
Name Description
id - ID! ID of the order
rating - Int rate for the order - between 0 and 5

Example

Query
mutation RateOrder(
  $id: ID!,
  $rating: Int
) {
  rateOrder(
    id: $id,
    rating: $rating
  ) {
    appliedDiscountId
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"id": 4, "rating": 987}
Response
{
  "data": {
    "rateOrder": {
      "appliedDiscountId": 4,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "buyerName": "xyz789",
      "cancel": true,
      "cartComment": "xyz789",
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customDiscount": "xyz789",
      "customId": "xyz789",
      "discountAmount": 987.65,
      "discountType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 123.45,
      "id": "4",
      "inform": true,
      "invoiceAddress": Address,
      "invoiceAddressId": 4,
      "invoiceDate": "2007-12-03",
      "invoiceNo": "xyz789",
      "isSeller": true,
      "labelsData": Json,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": "4",
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 123.45,
      "rangeOrderInt": "abc123",
      "rangeOrderText": "abc123",
      "rating": 123,
      "rep": User,
      "repCredential": Cred,
      "repCredentialId": "4",
      "repId": 4,
      "rows": [OrderRow],
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "shippingCosts": 123.45,
      "showTeamMemberSalesRep": true,
      "status": true,
      "sumOfProducts": 987.65,
      "supplierName": "abc123",
      "totalAmount": 123.45,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "vat": 987.65
    }
  }
}
Mutations

readNotification

Description

Mark a notification as read

Response

Returns a Notification

Arguments
Name Description
id - ID

Example

Query
mutation ReadNotification($id: ID) {
  readNotification(id: $id) {
    createdAt
    id
    object {
      ... on ConnectRequest {
        ...ConnectRequestFragment
      }
    }
    payload
    seenAt
    type
    updatedAt
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "readNotification": {
      "createdAt": "2007-12-03T10:15:30Z",
      "id": 4,
      "object": ConnectRequest,
      "payload": "abc123",
      "seenAt": "2007-12-03T10:15:30Z",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

refreshSearch

Description

Refresh search for a given type of objects like producs, orders, carts ...

Response

Returns a BackgroundJob

Arguments
Name Description
type - SearchItem! Type of items to be reindex.

Example

Query
mutation RefreshSearch($type: SearchItem!) {
  refreshSearch(type: $type) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"type": "CONTACTS"}
Response
{
  "data": {
    "refreshSearch": {
      "cartId": 4,
      "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"
    }
  }
}
Mutations

rejectConnectRequest

Description

Reject a connect request

Response

Returns a ConnectRequest

Arguments
Name Description
id - ID

Example

Query
mutation RejectConnectRequest($id: ID) {
  rejectConnectRequest(id: $id) {
    acceptedAt
    createdAt
    id
    rejectedAt
    requesterUser {
      ...UserFragment
    }
    source
    targetUser {
      ...UserFragment
    }
    term
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "rejectConnectRequest": {
      "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": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

removeAccessCustomers

Description

Remove accessCustomers.

Response

Returns a Contact

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

Example

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

removeAccessSuppliers

Description

Remove accessSuppliers.

Response

Returns a Contact

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

Example

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

removeDiscount

Description

Remove discount from a drop

Response

Returns a DropDiscount

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

Example

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

removeFromCart

Description

Remove product from a cart

Response

Returns a CartProduct

Arguments
Name Description
cartId - ID Cart identifier
cartUrlkey - String Cart urlkey
productId - ID! Product identifier
quantity - Float Optional quantity to be removed - all if not specified

Example

Query
mutation RemoveFromCart(
  $cartId: ID,
  $cartUrlkey: String,
  $productId: ID!,
  $quantity: Float
) {
  removeFromCart(
    cartId: $cartId,
    cartUrlkey: $cartUrlkey,
    productId: $productId,
    quantity: $quantity
  ) {
    cart {
      ...CartFragment
    }
    cartId
    id
    product {
      ...ProductFragment
    }
    productId
    quantity
    variants {
      ...CartProductFragment
    }
  }
}
Variables
{
  "cartId": 4,
  "cartUrlkey": "xyz789",
  "productId": 4,
  "quantity": 987.65
}
Response
{
  "data": {
    "removeFromCart": {
      "cart": Cart,
      "cartId": 4,
      "id": "4",
      "product": Product,
      "productId": "4",
      "quantity": 987.65,
      "variants": [CartProduct]
    }
  }
}
Mutations

removeMemberFromUserGroup

Description

Remove member from user group.

Response

Returns a UserGroupMember

Arguments
Name Description
contactId - ID
userGroupId - ID

Example

Query
mutation RemoveMemberFromUserGroup(
  $contactId: ID,
  $userGroupId: ID
) {
  removeMemberFromUserGroup(
    contactId: $contactId,
    userGroupId: $userGroupId
  ) {
    contact {
      ...ContactFragment
    }
    contactId
    id
    userGroupId
  }
}
Variables
{
  "contactId": "4",
  "userGroupId": "4"
}
Response
{
  "data": {
    "removeMemberFromUserGroup": {
      "contact": Contact,
      "contactId": 4,
      "id": 4,
      "userGroupId": 4
    }
  }
}
Mutations

removeProductGroup

Description

Remove product group

Response

Returns a ProductUserGroup

Arguments
Name Description
productGroupId - ID Product group ID

Example

Query
mutation RemoveProductGroup($productGroupId: ID) {
  removeProductGroup(productGroupId: $productGroupId) {
    id
    userGroup {
      ...UserGroupFragment
    }
  }
}
Variables
{"productGroupId": 4}
Response
{
  "data": {
    "removeProductGroup": {
      "id": 4,
      "userGroup": UserGroup
    }
  }
}
Mutations

removeProductOption

Description

Remove product options by productOptionId.

Response

Returns a ProductOption

Arguments
Name Description
id - ID! Product option id

Example

Query
mutation RemoveProductOption($id: ID!) {
  removeProductOption(id: $id) {
    id
    name
    order
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "removeProductOption": {
      "id": 4,
      "name": "abc123",
      "order": 123
    }
  }
}
Mutations

removeProductOptions

Description

Remove product options by groupId.

Response

Returns [ProductOption]

Arguments
Name Description
groupId - ID! Product option group id

Example

Query
mutation RemoveProductOptions($groupId: ID!) {
  removeProductOptions(groupId: $groupId) {
    id
    name
    order
  }
}
Variables
{"groupId": "4"}
Response
{
  "data": {
    "removeProductOptions": [
      {
        "id": "4",
        "name": "xyz789",
        "order": 123
      }
    ]
  }
}
Mutations

removeProductsFromDrop

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 RemoveProductsFromDrop(
  $dropId: ID,
  $productIds: [ID]
) {
  removeProductsFromDrop(
    dropId: $dropId,
    productIds: $productIds
  )
}
Variables
{
  "dropId": "4",
  "productIds": ["4"]
}
Response
{"data": {"removeProductsFromDrop": 123}}
Mutations

removeTeamGroupMember

Description

Remove a member from a team group

Response

Returns a TeamGroupMember

Arguments
Name Description
id - ID! ID of the team group member to remove

Example

Query
mutation RemoveTeamGroupMember($id: ID!) {
  removeTeamGroupMember(id: $id) {
    id
    teamGroup {
      ...TeamGroupFragment
    }
    teamGroupId
    teamUser {
      ...TeamUserFragment
    }
    teamUserId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "removeTeamGroupMember": {
      "id": "4",
      "teamGroup": TeamGroup,
      "teamGroupId": "4",
      "teamUser": TeamUser,
      "teamUserId": 4
    }
  }
}
Mutations

resendEmailLogin

Description

Resend email login code

Response

Returns an EmailLoginConfirmation

Arguments
Name Description
urlkey - String! Identifier for the email login request

Example

Query
mutation ResendEmailLogin($urlkey: String!) {
  resendEmailLogin(urlkey: $urlkey) {
    id
    urlkey
  }
}
Variables
{"urlkey": "abc123"}
Response
{
  "data": {
    "resendEmailLogin": {
      "id": 4,
      "urlkey": "xyz789"
    }
  }
}
Mutations

resendSignupVerificationEmail

Description

Resend signup verification email

Response

Returns a SignupConfirmation

Arguments
Name Description
urlkey - String Identifier for the signup confirmation

Example

Query
mutation ResendSignupVerificationEmail($urlkey: String) {
  resendSignupVerificationEmail(urlkey: $urlkey) {
    accountType
    id
    urlkey
  }
}
Variables
{"urlkey": "abc123"}
Response
{
  "data": {
    "resendSignupVerificationEmail": {
      "accountType": "BUYER",
      "id": "4",
      "urlkey": "xyz789"
    }
  }
}
Mutations

resetPassword

Description

Reset password

Response

Returns a Credential

Arguments
Name Description
password - String! new password
token - String! Password reset token

Example

Query
mutation ResetPassword(
  $password: String!,
  $token: String!
) {
  resetPassword(
    password: $password,
    token: $token
  ) {
    accountType
    avatar
    email
    firstName
    isAdmin
    lastName
    nlAccept
    plan {
      ...PlanFragment
    }
    recovery
    recoveryInform
    representing {
      ...UserFragment
    }
    status
    user {
      ...UserFragment
    }
    userId
    welcome
  }
}
Variables
{
  "password": "xyz789",
  "token": "abc123"
}
Response
{
  "data": {
    "resetPassword": {
      "accountType": "BUYER",
      "avatar": "abc123",
      "email": "abc123",
      "firstName": "xyz789",
      "isAdmin": true,
      "lastName": "xyz789",
      "nlAccept": false,
      "plan": Plan,
      "recovery": "xyz789",
      "recoveryInform": false,
      "representing": [User],
      "status": false,
      "user": User,
      "userId": "4",
      "welcome": true
    }
  }
}
Mutations

returnOrderToStock

Description

return order to stock

Response

Returns an Order

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

Example

Query
mutation ReturnOrderToStock(
  $id: ID,
  $urlkey: String
) {
  returnOrderToStock(
    id: $id,
    urlkey: $urlkey
  ) {
    appliedDiscountId
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
  "data": {
    "returnOrderToStock": {
      "appliedDiscountId": 4,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "buyerName": "xyz789",
      "cancel": false,
      "cartComment": "xyz789",
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customDiscount": "abc123",
      "customId": "abc123",
      "discountAmount": 123.45,
      "discountType": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "extraCosts": 123.45,
      "id": 4,
      "inform": true,
      "invoiceAddress": Address,
      "invoiceAddressId": 4,
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": false,
      "labelsData": Json,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "xyz789",
      "owner": User,
      "ownerId": 4,
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 987.65,
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "abc123",
      "rating": 987,
      "rep": User,
      "repCredential": Cred,
      "repCredentialId": "4",
      "repId": "4",
      "rows": [OrderRow],
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "shippingCosts": 987.65,
      "showTeamMemberSalesRep": false,
      "status": false,
      "sumOfProducts": 987.65,
      "supplierName": "xyz789",
      "totalAmount": 987.65,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "vat": 987.65
    }
  }
}
Mutations

sendCartReminder

Description

Send cart reminder.

Response

Returns a BackgroundJob

Arguments
Name Description
cartId - ID ID of the cart.

Example

Query
mutation SendCartReminder($cartId: ID) {
  sendCartReminder(cartId: $cartId) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"cartId": "4"}
Response
{
  "data": {
    "sendCartReminder": {
      "cartId": "4",
      "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"
    }
  }
}
Mutations

sendConnectRequest

Description

Send a connect request to user

Response

Returns a ConnectRequest

Arguments
Name Description
source - String Source leading to the connect request.
term - String Identifies search terms leading to the connect request
userId - ID!

Example

Query
mutation SendConnectRequest(
  $source: String,
  $term: String,
  $userId: ID!
) {
  sendConnectRequest(
    source: $source,
    term: $term,
    userId: $userId
  ) {
    acceptedAt
    createdAt
    id
    rejectedAt
    requesterUser {
      ...UserFragment
    }
    source
    targetUser {
      ...UserFragment
    }
    term
    updatedAt
  }
}
Variables
{
  "source": "xyz789",
  "term": "xyz789",
  "userId": "4"
}
Response
{
  "data": {
    "sendConnectRequest": {
      "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": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

sendOrderConfirmation

Description

Trigger resending of order confirmation email

Response

Returns an Order

Arguments
Name Description
id - ID order id

Example

Query
mutation SendOrderConfirmation($id: ID) {
  sendOrderConfirmation(id: $id) {
    appliedDiscountId
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{"id": "4"}
Response
{
  "data": {
    "sendOrderConfirmation": {
      "appliedDiscountId": 4,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "buyerName": "abc123",
      "cancel": false,
      "cartComment": "abc123",
      "comment": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customDiscount": "abc123",
      "customId": "xyz789",
      "discountAmount": 123.45,
      "discountType": "abc123",
      "drop": Drop,
      "dropId": 4,
      "extraCosts": 123.45,
      "id": 4,
      "inform": true,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "invoiceDate": "2007-12-03",
      "invoiceNo": "abc123",
      "isSeller": false,
      "labelsData": Json,
      "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,
      "repCredential": Cred,
      "repCredentialId": "4",
      "repId": "4",
      "rows": [OrderRow],
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "shippingCosts": 123.45,
      "showTeamMemberSalesRep": false,
      "status": true,
      "sumOfProducts": 123.45,
      "supplierName": "abc123",
      "totalAmount": 987.65,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "vat": 987.65
    }
  }
}
Mutations

setUserPlan

Description

Set subscription plan for the current user

Response

Returns a UserPlan

Arguments
Name Description
planId - ID! Unique identifier of the plan
userId - ID Optional identifier of the user, defaults to current user

Example

Query
mutation SetUserPlan(
  $planId: ID!,
  $userId: ID
) {
  setUserPlan(
    planId: $planId,
    userId: $userId
  ) {
    id
    name
    plan {
      ...PlanFragment
    }
    stripeProductId
    stripeSubscriptionId
    user {
      ...UserFragment
    }
  }
}
Variables
{"planId": "4", "userId": 4}
Response
{
  "data": {
    "setUserPlan": {
      "id": 4,
      "name": "abc123",
      "plan": Plan,
      "stripeProductId": "xyz789",
      "stripeSubscriptionId": "abc123",
      "user": User
    }
  }
}
Mutations

shareDrop

Response

Returns a Drop

Arguments
Name Description
id - ID ID of the Drop
input - ShareDropInput! Sharing details and configuration. Default = {allContacts: false, sendMeACopy: false}
urlkey - String urlkey of the Drop

Example

Query
mutation ShareDrop(
  $id: ID,
  $input: ShareDropInput!,
  $urlkey: String
) {
  shareDrop(
    id: $id,
    input: $input,
    urlkey: $urlkey
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{
  "id": 4,
  "input": {"allContacts": "false", "sendMeACopy": "false"},
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "shareDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 123,
      "archive": false,
      "asset": "abc123",
      "assets": ["abc123"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "abc123",
      "currencyBuy": "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": [123],
      "id": "4",
      "images": ["abc123"],
      "img": "xyz789",
      "info": "abc123",
      "isPublic": false,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "note": "xyz789",
      "openrate": 123,
      "order": 123,
      "orderItemsQty": 123.45,
      "orderQty": 123,
      "orderTotal": 987.65,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "abc123",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "abc123",
      "public": false,
      "publicVisitorCount": 987,
      "rangeDropInt": "abc123",
      "rangeDropText": "abc123",
      "season": "xyz789",
      "sharedWithAll": false,
      "status": 123,
      "supplier": Contact,
      "supplierName": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

shopifyActivateWebhooks

Description

shopify activate webhooks

Response

Returns a ShopifyIntegrationData

Arguments
Name Description
id - ID! partner_integration_id

Example

Query
mutation ShopifyActivateWebhooks($id: ID!) {
  shopifyActivateWebhooks(id: $id) {
    isActive
    orderFinancialStatus
    orderSyncStatus
    productsSynced
    syncActiveInventory
    syncCostAsPrice
    syncDraftInventory
    syncOrderUpdates
    syncOrders
    syncPriceAndRrp
    webhooksActivated
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "shopifyActivateWebhooks": {
      "isActive": false,
      "orderFinancialStatus": "abc123",
      "orderSyncStatus": "abc123",
      "productsSynced": true,
      "syncActiveInventory": false,
      "syncCostAsPrice": true,
      "syncDraftInventory": false,
      "syncOrderUpdates": true,
      "syncOrders": false,
      "syncPriceAndRrp": false,
      "webhooksActivated": false
    }
  }
}
Mutations

shopifySyncProducts

Description

shopify sync products

Response

Returns a ShopifyIntegrationData

Arguments
Name Description
id - ID! partner_integration_id

Example

Query
mutation ShopifySyncProducts($id: ID!) {
  shopifySyncProducts(id: $id) {
    isActive
    orderFinancialStatus
    orderSyncStatus
    productsSynced
    syncActiveInventory
    syncCostAsPrice
    syncDraftInventory
    syncOrderUpdates
    syncOrders
    syncPriceAndRrp
    webhooksActivated
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "shopifySyncProducts": {
      "isActive": false,
      "orderFinancialStatus": "abc123",
      "orderSyncStatus": "xyz789",
      "productsSynced": false,
      "syncActiveInventory": false,
      "syncCostAsPrice": false,
      "syncDraftInventory": false,
      "syncOrderUpdates": true,
      "syncOrders": false,
      "syncPriceAndRrp": true,
      "webhooksActivated": false
    }
  }
}
Mutations

shopifyToggleSyncOrders

Description

shopify toggle sync_orders

Response

Returns a ShopifyIntegrationData

Arguments
Name Description
id - ID! partner_integration_id

Example

Query
mutation ShopifyToggleSyncOrders($id: ID!) {
  shopifyToggleSyncOrders(id: $id) {
    isActive
    orderFinancialStatus
    orderSyncStatus
    productsSynced
    syncActiveInventory
    syncCostAsPrice
    syncDraftInventory
    syncOrderUpdates
    syncOrders
    syncPriceAndRrp
    webhooksActivated
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "shopifyToggleSyncOrders": {
      "isActive": true,
      "orderFinancialStatus": "xyz789",
      "orderSyncStatus": "abc123",
      "productsSynced": true,
      "syncActiveInventory": true,
      "syncCostAsPrice": false,
      "syncDraftInventory": true,
      "syncOrderUpdates": true,
      "syncOrders": true,
      "syncPriceAndRrp": false,
      "webhooksActivated": true
    }
  }
}
Mutations

signup

Description

Create an account on the platfrom

Response

Returns a SignupConfirmation

Arguments
Name Description
input - SignupInput Fields required for creating an account on the platform.

Example

Query
mutation Signup($input: SignupInput) {
  signup(input: $input) {
    accountType
    id
    urlkey
  }
}
Variables
{"input": SignupInput}
Response
{
  "data": {
    "signup": {
      "accountType": "BUYER",
      "id": 4,
      "urlkey": "xyz789"
    }
  }
}
Mutations

signupConfirm

Description

Verify ownership of the durring signup provided email.

Response

Returns a Session

Arguments
Name Description
input - SignupConfirmInput Fields required for confirming an account on the platform.

Example

Query
mutation SignupConfirm($input: SignupConfirmInput) {
  signupConfirm(input: $input) {
    id
    user {
      ...UserFragment
    }
  }
}
Variables
{"input": SignupConfirmInput}
Response
{
  "data": {
    "signupConfirm": {
      "id": "4",
      "user": User
    }
  }
}
Mutations

switchWorkspace

Description

Switch workspace.

Response

Returns a String

Arguments
Name Description
userId - ID userId of the other workspace.

Example

Query
mutation SwitchWorkspace($userId: ID) {
  switchWorkspace(userId: $userId)
}
Variables
{"userId": 4}
Response
{"data": {"switchWorkspace": "abc123"}}
Mutations

teamUserAddAccessContacts

Description

Add access contacts

Response

Returns a TeamUser

Arguments
Name Description
contactIds - [ID] Ids of the contacts. Default = []
id - ID
userGroupIds - [ID] Ids of the user groups. Default = []

Example

Query
mutation TeamUserAddAccessContacts(
  $contactIds: [ID],
  $id: ID,
  $userGroupIds: [ID]
) {
  teamUserAddAccessContacts(
    contactIds: $contactIds,
    id: $id,
    userGroupIds: $userGroupIds
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{
  "contactIds": [""],
  "id": "4",
  "userGroupIds": [""]
}
Response
{
  "data": {
    "teamUserAddAccessContacts": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": true,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": 4,
      "id": "4",
      "role": "abc123",
      "userId": 4
    }
  }
}
Mutations

teamUserAddAccessSuppliers

Description

Add access suppliers

Response

Returns a TeamUser

Arguments
Name Description
id - ID
supplierIds - [ID] Ids of the suppliers.

Example

Query
mutation TeamUserAddAccessSuppliers(
  $id: ID,
  $supplierIds: [ID]
) {
  teamUserAddAccessSuppliers(
    id: $id,
    supplierIds: $supplierIds
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"id": "4", "supplierIds": [4]}
Response
{
  "data": {
    "teamUserAddAccessSuppliers": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": false,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": 4,
      "id": "4",
      "role": "abc123",
      "userId": "4"
    }
  }
}
Mutations

teamUserRemoveAccessContacts

Description

Remove access contacts

Response

Returns a TeamUser

Arguments
Name Description
contactIds - [ID] Ids of the contacts. Default = []
id - ID
userGroupIds - [ID] Ids of the contacts. Default = []

Example

Query
mutation TeamUserRemoveAccessContacts(
  $contactIds: [ID],
  $id: ID,
  $userGroupIds: [ID]
) {
  teamUserRemoveAccessContacts(
    contactIds: $contactIds,
    id: $id,
    userGroupIds: $userGroupIds
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"contactIds": [""], "id": 4, "userGroupIds": [""]}
Response
{
  "data": {
    "teamUserRemoveAccessContacts": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": false,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": 4,
      "id": 4,
      "role": "abc123",
      "userId": 4
    }
  }
}
Mutations

teamUserRemoveAccessSuppliers

Description

Remove access suppliers

Response

Returns a TeamUser

Arguments
Name Description
id - ID
supplierIds - [ID] Ids of the suppliers.

Example

Query
mutation TeamUserRemoveAccessSuppliers(
  $id: ID,
  $supplierIds: [ID]
) {
  teamUserRemoveAccessSuppliers(
    id: $id,
    supplierIds: $supplierIds
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{
  "id": "4",
  "supplierIds": ["4"]
}
Response
{
  "data": {
    "teamUserRemoveAccessSuppliers": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": false,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": "4",
      "id": "4",
      "role": "xyz789",
      "userId": "4"
    }
  }
}
Mutations

toggleCanSeeAllContacts

Description

Toggle can see all contacts flag.

Response

Returns a TeamUser

Arguments
Name Description
id - ID

Example

Query
mutation ToggleCanSeeAllContacts($id: ID) {
  toggleCanSeeAllContacts(id: $id) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "toggleCanSeeAllContacts": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": true,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": "4",
      "id": 4,
      "role": "abc123",
      "userId": 4
    }
  }
}
Mutations

unreadNotification

Description

Mark a notification as unread

Response

Returns a Notification

Arguments
Name Description
id - ID

Example

Query
mutation UnreadNotification($id: ID) {
  unreadNotification(id: $id) {
    createdAt
    id
    object {
      ... on ConnectRequest {
        ...ConnectRequestFragment
      }
    }
    payload
    seenAt
    type
    updatedAt
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "unreadNotification": {
      "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"
    }
  }
}
Mutations

updateAddress

Description

update address

Response

Returns an Address

Arguments
Name Description
data - AddressInput Address data
id - ID ID of the address

Example

Query
mutation UpdateAddress(
  $data: AddressInput,
  $id: ID
) {
  updateAddress(
    data: $data,
    id: $id
  ) {
    addressLine1
    addressLine2
    city
    company
    country
    description
    email
    firstName
    id
    lastName
    phone
    postalCode
    state
  }
}
Variables
{"data": AddressInput, "id": 4}
Response
{
  "data": {
    "updateAddress": {
      "addressLine1": "abc123",
      "addressLine2": "abc123",
      "city": "xyz789",
      "company": "abc123",
      "country": "xyz789",
      "description": "xyz789",
      "email": "abc123",
      "firstName": "xyz789",
      "id": 4,
      "lastName": "abc123",
      "phone": "xyz789",
      "postalCode": "xyz789",
      "state": "abc123"
    }
  }
}
Mutations

updateCart

Description

update single Cart by ID or urlkey

Response

Returns a Cart

Arguments
Name Description
cartData - CartInput updated Cart data
id - ID ID of the Cart
urlkey - String urlkey of the Cart

Example

Query
mutation UpdateCart(
  $cartData: CartInput,
  $id: ID,
  $urlkey: String
) {
  updateCart(
    cartData: $cartData,
    id: $id,
    urlkey: $urlkey
  ) {
    _cartProductsMeta {
      ...CartProductsMetaFragment
    }
    _parentProductsMeta {
      ...CartProductsMetaFragment
    }
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    cartProducts {
      ...CartProductFragment
    }
    cartReminderInfo {
      ...CartReminderInfoFragment
    }
    comment
    createdAt
    creatorType
    drop {
      ...DropFragment
    }
    dropId
    guestId
    id
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    isPrivate
    ownerId
    parentProducts {
      ...CartProductFragment
    }
    repId
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    updatedAt
    urlkey
  }
}
Variables
{
  "cartData": CartInput,
  "id": 4,
  "urlkey": "abc123"
}
Response
{
  "data": {
    "updateCart": {
      "_cartProductsMeta": CartProductsMeta,
      "_parentProductsMeta": CartProductsMeta,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": "4",
      "cartProducts": [CartProduct],
      "cartReminderInfo": CartReminderInfo,
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "creatorType": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "guestId": "4",
      "id": "4",
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "isPrivate": false,
      "ownerId": 4,
      "parentProducts": [CartProduct],
      "repId": "4",
      "seller": User,
      "sellerId": 4,
      "shippingAddress": Address,
      "shippingAddressId": 4,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789"
    }
  }
}
Mutations

updateCartLabelValue

Description

Update cart label value

Response

Returns a CartLabelValue

Arguments
Name Description
id - ID Cart label value id
value - String

Example

Query
mutation UpdateCartLabelValue(
  $id: ID,
  $value: String
) {
  updateCartLabelValue(
    id: $id,
    value: $value
  ) {
    cartId
    id
    labelId
    orderId
    value
  }
}
Variables
{
  "id": "4",
  "value": "abc123"
}
Response
{
  "data": {
    "updateCartLabelValue": {
      "cartId": "4",
      "id": 4,
      "labelId": 4,
      "orderId": "4",
      "value": "abc123"
    }
  }
}
Mutations

updateCartProduct

Description

Update the quantity of a product in cart

Response

Returns a CartProduct

Arguments
Name Description
cartId - ID ID of the Cart
cartUrlkey - String urlkey of the Cart
productId - ID! Product id whos quantity needs to be adjusted
quantity - Float! New quantity of the product in cart

Example

Query
mutation UpdateCartProduct(
  $cartId: ID,
  $cartUrlkey: String,
  $productId: ID!,
  $quantity: Float!
) {
  updateCartProduct(
    cartId: $cartId,
    cartUrlkey: $cartUrlkey,
    productId: $productId,
    quantity: $quantity
  ) {
    cart {
      ...CartFragment
    }
    cartId
    id
    product {
      ...ProductFragment
    }
    productId
    quantity
    variants {
      ...CartProductFragment
    }
  }
}
Variables
{
  "cartId": "4",
  "cartUrlkey": "xyz789",
  "productId": 4,
  "quantity": 123.45
}
Response
{
  "data": {
    "updateCartProduct": {
      "cart": Cart,
      "cartId": "4",
      "id": "4",
      "product": Product,
      "productId": 4,
      "quantity": 987.65,
      "variants": [CartProduct]
    }
  }
}
Mutations

updateCartProductLabelValue

Description

Update cart product label value

Response

Returns a CartProductLabelValue

Arguments
Name Description
id - ID Cart product label value id
value - String

Example

Query
mutation UpdateCartProductLabelValue(
  $id: ID,
  $value: String
) {
  updateCartProductLabelValue(
    id: $id,
    value: $value
  ) {
    cartId
    id
    labelId
    orderId
    productId
    value
  }
}
Variables
{"id": 4, "value": "xyz789"}
Response
{
  "data": {
    "updateCartProductLabelValue": {
      "cartId": 4,
      "id": "4",
      "labelId": "4",
      "orderId": 4,
      "productId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

updateContact

Description

update contact

Response

Returns a String

Arguments
Name Description
data - ContactInput contact data
id - ID id of the contact to be updated

Example

Query
mutation UpdateContact(
  $data: ContactInput,
  $id: ID
) {
  updateContact(
    data: $data,
    id: $id
  )
}
Variables
{"data": ContactInput, "id": 4}
Response
{"data": {"updateContact": "abc123"}}
Mutations

updateContactAddress

Description

update contact address

Response

Returns a ContactAddress

Arguments
Name Description
addressInput - AddressInput Address input
contactAddressId - ID Contact address id

Example

Query
mutation UpdateContactAddress(
  $addressInput: AddressInput,
  $contactAddressId: ID
) {
  updateContactAddress(
    addressInput: $addressInput,
    contactAddressId: $contactAddressId
  ) {
    address {
      ...AddressFragment
    }
    addressId
    contactId
    id
  }
}
Variables
{"addressInput": AddressInput, "contactAddressId": 4}
Response
{
  "data": {
    "updateContactAddress": {
      "address": Address,
      "addressId": 4,
      "contactId": "4",
      "id": 4
    }
  }
}
Mutations

updateContactLabelValue

Description

Update contact label value

Response

Returns a ContactLabelValue

Arguments
Name Description
id - ID Contact label value id
value - String

Example

Query
mutation UpdateContactLabelValue(
  $id: ID,
  $value: String
) {
  updateContactLabelValue(
    id: $id,
    value: $value
  ) {
    contactId
    id
    labelId
    value
  }
}
Variables
{"id": 4, "value": "abc123"}
Response
{
  "data": {
    "updateContactLabelValue": {
      "contactId": "4",
      "id": 4,
      "labelId": 4,
      "value": "abc123"
    }
  }
}
Mutations

updateDiscount

Description

Update discount

Response

Returns a Discount

Arguments
Name Description
discount - DiscountInput
id - ID Id of the discount
urlkey - ID Non sequential identifier of the discount

Example

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

updateDrop

Response

Returns a Drop

Arguments
Name Description
dropData - DropInput! drop data for updateing
id - ID ID of the Drop
urlkey - String urlkey of the Drop

Example

Query
mutation UpdateDrop(
  $dropData: DropInput!,
  $id: ID,
  $urlkey: String
) {
  updateDrop(
    dropData: $dropData,
    id: $id,
    urlkey: $urlkey
  ) {
    _dropProductsMeta {
      ...ProductsMetaFragment
    }
    _products {
      ...ProductsMetaFragment
    }
    access
    archive
    asset
    assets
    assetsArchiveGeneratedAt
    assetsArchiveUrl
    createdAt
    csvSource
    currencyBuy
    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
    public
    publicVisitorCount
    rangeDropInt
    rangeDropText
    season
    sharedWithAll
    status
    supplier {
      ...ContactFragment
    }
    supplierName
    updatedAt
    urlkey
  }
}
Variables
{
  "dropData": DropInput,
  "id": 4,
  "urlkey": "xyz789"
}
Response
{
  "data": {
    "updateDrop": {
      "_dropProductsMeta": ProductsMeta,
      "_products": ProductsMeta,
      "access": 987,
      "archive": false,
      "asset": "abc123",
      "assets": ["xyz789"],
      "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
      "assetsArchiveUrl": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "csvSource": "xyz789",
      "currencyBuy": "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": [123],
      "id": 4,
      "images": ["xyz789"],
      "img": "xyz789",
      "info": "xyz789",
      "isPublic": true,
      "lastPromotion": "2007-12-03T10:15:30Z",
      "name": "abc123",
      "note": "xyz789",
      "openrate": 123,
      "order": 123,
      "orderItemsQty": 123.45,
      "orderQty": 987,
      "orderTotal": 123.45,
      "orderTotalArray": [OrderTotal],
      "owner": User,
      "ownerId": "abc123",
      "pdfGeneratedAt": "2007-12-03T10:15:30Z",
      "pdfUrl": "abc123",
      "public": true,
      "publicVisitorCount": 987,
      "rangeDropInt": "abc123",
      "rangeDropText": "abc123",
      "season": "xyz789",
      "sharedWithAll": true,
      "status": 123,
      "supplier": Contact,
      "supplierName": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123"
    }
  }
}
Mutations

updateDropLabelValue

Description

Update drop label value

Response

Returns a DropLabelValue

Arguments
Name Description
id - ID drop label value id
value - String

Example

Query
mutation UpdateDropLabelValue(
  $id: ID,
  $value: String
) {
  updateDropLabelValue(
    id: $id,
    value: $value
  ) {
    dropId
    id
    labelId
    value
  }
}
Variables
{"id": 4, "value": "xyz789"}
Response
{
  "data": {
    "updateDropLabelValue": {
      "dropId": 4,
      "id": "4",
      "labelId": 4,
      "value": "xyz789"
    }
  }
}
Mutations

updateDropProduct

Description

Updates Drop and product association - currenty only one field rowOrder

Response

Returns a DropProduct

Arguments
Name Description
dropId - ID ID of the Drop
id - ID ID of the DropProduct association
productId - ID ID of the Product
rowOrder - Int! Product order in the drop products list

Example

Query
mutation UpdateDropProduct(
  $dropId: ID,
  $id: ID,
  $productId: ID,
  $rowOrder: Int!
) {
  updateDropProduct(
    dropId: $dropId,
    id: $id,
    productId: $productId,
    rowOrder: $rowOrder
  ) {
    dropId
    id
    product {
      ...ProductFragment
    }
    productId
    rowOrder
  }
}
Variables
{
  "dropId": 4,
  "id": "4",
  "productId": 4,
  "rowOrder": 123
}
Response
{
  "data": {
    "updateDropProduct": {
      "dropId": 4,
      "id": 4,
      "product": Product,
      "productId": "4",
      "rowOrder": 987
    }
  }
}
Mutations

updateIntegrationConfiguration

Description

Mutation for updating a integration_configuration

Response

Returns an IntegrationConfiguration

Arguments
Name Description
input - IntegrationConfigurationInput integration configuration input
integrationConfigurationId - ID! id of integration_configuration to update

Example

Query
mutation UpdateIntegrationConfiguration(
  $input: IntegrationConfigurationInput,
  $integrationConfigurationId: ID!
) {
  updateIntegrationConfiguration(
    input: $input,
    integrationConfigurationId: $integrationConfigurationId
  ) {
    id
    key
    partnerIntegrationId
    value
  }
}
Variables
{
  "input": IntegrationConfigurationInput,
  "integrationConfigurationId": 4
}
Response
{
  "data": {
    "updateIntegrationConfiguration": {
      "id": "4",
      "key": "xyz789",
      "partnerIntegrationId": "4",
      "value": "xyz789"
    }
  }
}
Mutations

updateLabel

Description

update label

Response

Returns a Label

Arguments
Name Description
id - ID
input - LabelInput

Example

Query
mutation UpdateLabel(
  $id: ID,
  $input: LabelInput
) {
  updateLabel(
    id: $id,
    input: $input
  ) {
    id
    name
    objectType
    objectTypes
    public
    selectOptions
    type
  }
}
Variables
{"id": 4, "input": LabelInput}
Response
{
  "data": {
    "updateLabel": {
      "id": 4,
      "name": "xyz789",
      "objectType": "xyz789",
      "objectTypes": ["abc123"],
      "public": false,
      "selectOptions": ["abc123"],
      "type": "xyz789"
    }
  }
}
Mutations

updateOrder

Description

update order

Response

Returns a String

Arguments
Name Description
data - OrderInput order data
id - Int

Example

Query
mutation UpdateOrder(
  $data: OrderInput,
  $id: Int
) {
  updateOrder(
    data: $data,
    id: $id
  )
}
Variables
{"data": OrderInput, "id": 987}
Response
{"data": {"updateOrder": "abc123"}}
Mutations

updateOrder2

Response

Returns an Order

Arguments
Name Description
data - OrderInput order data
id - ID
urlkey - String

Example

Query
mutation UpdateOrder2(
  $data: OrderInput,
  $id: ID,
  $urlkey: String
) {
  updateOrder2(
    data: $data,
    id: $id,
    urlkey: $urlkey
  ) {
    appliedDiscountId
    buyer {
      ...UserFragment
    }
    buyerAddresses {
      ...AddressFragment
    }
    buyerId
    buyerName
    cancel
    cartComment
    comment
    createdAt
    currency
    customDiscount
    customId
    discountAmount
    discountType
    drop {
      ...DropFragment
    }
    dropId
    extraCosts
    id
    inform
    invoiceAddress {
      ...AddressFragment
    }
    invoiceAddressId
    invoiceDate
    invoiceNo
    isSeller
    labelsData
    orderExtraCosts {
      ...OrderExtraCostFragment
    }
    orderMeta {
      ...OrderMetaFragment
    }
    orderTag
    owner {
      ...UserFragment
    }
    ownerId
    parentProducts {
      ...OrderProductFragment
    }
    products {
      ...ProductFragment
    }
    qty
    rangeOrderInt
    rangeOrderText
    rating
    rep {
      ...UserFragment
    }
    repCredential {
      ...CredFragment
    }
    repCredentialId
    repId
    rows {
      ...OrderRowFragment
    }
    seller {
      ...UserFragment
    }
    sellerId
    shippingAddress {
      ...AddressFragment
    }
    shippingAddressId
    shippingCosts
    showTeamMemberSalesRep
    status
    sumOfProducts
    supplierName
    totalAmount
    updatedAt
    urlkey
    vat
  }
}
Variables
{
  "data": OrderInput,
  "id": 4,
  "urlkey": "abc123"
}
Response
{
  "data": {
    "updateOrder2": {
      "appliedDiscountId": 4,
      "buyer": User,
      "buyerAddresses": [Address],
      "buyerId": 4,
      "buyerName": "xyz789",
      "cancel": true,
      "cartComment": "xyz789",
      "comment": "xyz789",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customDiscount": "xyz789",
      "customId": "xyz789",
      "discountAmount": 123.45,
      "discountType": "xyz789",
      "drop": Drop,
      "dropId": "4",
      "extraCosts": 123.45,
      "id": 4,
      "inform": true,
      "invoiceAddress": Address,
      "invoiceAddressId": "4",
      "invoiceDate": "2007-12-03",
      "invoiceNo": "xyz789",
      "isSeller": true,
      "labelsData": Json,
      "orderExtraCosts": [OrderExtraCost],
      "orderMeta": OrderMeta,
      "orderTag": "abc123",
      "owner": User,
      "ownerId": 4,
      "parentProducts": [OrderProduct],
      "products": [Product],
      "qty": 123.45,
      "rangeOrderInt": "xyz789",
      "rangeOrderText": "xyz789",
      "rating": 123,
      "rep": User,
      "repCredential": Cred,
      "repCredentialId": "4",
      "repId": "4",
      "rows": [OrderRow],
      "seller": User,
      "sellerId": "4",
      "shippingAddress": Address,
      "shippingAddressId": "4",
      "shippingCosts": 123.45,
      "showTeamMemberSalesRep": true,
      "status": false,
      "sumOfProducts": 987.65,
      "supplierName": "abc123",
      "totalAmount": 987.65,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "vat": 987.65
    }
  }
}
Mutations

updateOrderExtraCost

Response

Returns an OrderExtraCost

Arguments
Name Description
data - OrderExtraCostInput Order extra cost input
id - ID! ID of the order extra cost

Example

Query
mutation UpdateOrderExtraCost(
  $data: OrderExtraCostInput,
  $id: ID!
) {
  updateOrderExtraCost(
    data: $data,
    id: $id
  ) {
    amount
    id
    name
    taxRatio
  }
}
Variables
{"data": OrderExtraCostInput, "id": 4}
Response
{
  "data": {
    "updateOrderExtraCost": {
      "amount": 987.65,
      "id": "4",
      "name": "abc123",
      "taxRatio": 123.45
    }
  }
}
Mutations

updatePassword

Description

Update password

Response

Returns a String

Arguments
Name Description
newPassword - String! New password of the user
password - String! Current Password of the user

Example

Query
mutation UpdatePassword(
  $newPassword: String!,
  $password: String!
) {
  updatePassword(
    newPassword: $newPassword,
    password: $password
  )
}
Variables
{
  "newPassword": "xyz789",
  "password": "abc123"
}
Response
{"data": {"updatePassword": "abc123"}}
Mutations

updatePaymentSubscription

Description

Update paymentSubscription.

Response

Returns a PaymentSubscription

Arguments
Name Description
data - PaymentSubscriptionInput
id - ID

Example

Query
mutation UpdatePaymentSubscription(
  $data: PaymentSubscriptionInput,
  $id: ID
) {
  updatePaymentSubscription(
    data: $data,
    id: $id
  ) {
    id
    stripeCustomerId
    stripePlanName
    stripeProductId
    stripeSubscriptionId
    stripeSubscriptionStatus
  }
}
Variables
{"data": PaymentSubscriptionInput, "id": 4}
Response
{
  "data": {
    "updatePaymentSubscription": {
      "id": "4",
      "stripeCustomerId": "xyz789",
      "stripePlanName": "xyz789",
      "stripeProductId": "abc123",
      "stripeSubscriptionId": "xyz789",
      "stripeSubscriptionStatus": "abc123"
    }
  }
}
Mutations

updatePricelistValue

Description

Update pricelist value

Response

Returns a PricelistValue

Arguments
Name Description
id - ID! Pricelist value ID
pricelistValue - UpdatePricelistValueInput!

Example

Query
mutation UpdatePricelistValue(
  $id: ID!,
  $pricelistValue: UpdatePricelistValueInput!
) {
  updatePricelistValue(
    id: $id,
    pricelistValue: $pricelistValue
  ) {
    currency
    id
    priceContacts {
      ...PriceContactFragment
    }
    prices {
      ...PriceFragment
    }
    product {
      ...ProductFragment
    }
    productId
  }
}
Variables
{
  "id": "4",
  "pricelistValue": UpdatePricelistValueInput
}
Response
{
  "data": {
    "updatePricelistValue": {
      "currency": "abc123",
      "id": "4",
      "priceContacts": [PriceContact],
      "prices": [Price],
      "product": Product,
      "productId": "4"
    }
  }
}
Mutations

updateProduct

Description

Update single product data

Response

Returns a Product

Arguments
Name Description
data - UpdateProductInput! Attributes to updates within the product.
id - ID Unique identifier of the entity

Example

Query
mutation UpdateProduct(
  $data: UpdateProductInput!,
  $id: ID
) {
  updateProduct(
    data: $data,
    id: $id
  ) {
    color
    cost
    costCurrency
    createdAt
    currency
    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
    origin
    owner {
      ...UserFragment
    }
    ownerId
    parent {
      ...ProductFragment
    }
    parentId
    parentOrChild
    price
    productUserGroups {
      ...ProductUserGroupFragment
    }
    rangeProductInt
    rangeProductText
    rowOrder
    rrp
    sku
    soldOut
    source
    supplier {
      ...ContactFragment
    }
    supplierId
    supplierName
    taric
    type
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
    variants {
      ...ProductFragment
    }
    variantsV2 {
      ...ProductVariantFragment
    }
  }
}
Variables
{
  "data": UpdateProductInput,
  "id": "4"
}
Response
{
  "data": {
    "updateProduct": {
      "color": "xyz789",
      "cost": 987.65,
      "costCurrency": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "abc123",
      "customField1": "abc123",
      "customField2": "abc123",
      "customField3": "abc123",
      "customField4": "xyz789",
      "customField5": "xyz789",
      "customField6": "xyz789",
      "customField7": "abc123",
      "customField8": "xyz789",
      "customId": "abc123",
      "customIdInt": "xyz789",
      "customIdText": "xyz789",
      "ean": "abc123",
      "externalProducts": [ExternalProduct],
      "id": "4",
      "images": ["xyz789"],
      "img": "abc123",
      "info": "xyz789",
      "inventoryStock": "abc123",
      "inventoryStockLimit": "abc123",
      "material": "abc123",
      "name": "abc123",
      "optionGroups": [ProductOptionGroup],
      "optionValue1": "abc123",
      "optionValue2": "xyz789",
      "optionValue3": "xyz789",
      "origin": "xyz789",
      "owner": User,
      "ownerId": "xyz789",
      "parent": Product,
      "parentId": "4",
      "parentOrChild": "abc123",
      "price": 987.65,
      "productUserGroups": [ProductUserGroup],
      "rangeProductInt": "abc123",
      "rangeProductText": "xyz789",
      "rowOrder": 987,
      "rrp": "abc123",
      "sku": "abc123",
      "soldOut": false,
      "source": "xyz789",
      "supplier": Contact,
      "supplierId": "4",
      "supplierName": "xyz789",
      "taric": "xyz789",
      "type": "xyz789",
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "xyz789",
      "variantCustomField1": "abc123",
      "variantCustomField2": "abc123",
      "variantCustomField3": "abc123",
      "variants": [Product],
      "variantsV2": [ProductVariant]
    }
  }
}
Mutations

updateProductInBackground

Description

Update product in a backround job.

Response

Returns a BackgroundJob

Arguments
Name Description
data - ProductInput Product input
id - ID Product id to update

Example

Query
mutation UpdateProductInBackground(
  $data: ProductInput,
  $id: ID
) {
  updateProductInBackground(
    data: $data,
    id: $id
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{"data": ProductInput, "id": 4}
Response
{
  "data": {
    "updateProductInBackground": {
      "cartId": "4",
      "completedAt": "2007-12-03T10:15:30Z",
      "contactId": 4,
      "createdAt": "2007-12-03T10:15:30Z",
      "dropId": 4,
      "id": "4",
      "orderId": "4",
      "result": "abc123",
      "type": "abc123",
      "updatedAt": "2007-12-03T10:15:30Z"
    }
  }
}
Mutations

updateProductLabelValue

Description

Update product label value

Response

Returns a ProductLabelValue

Arguments
Name Description
id - ID product label value id
value - String

Example

Query
mutation UpdateProductLabelValue(
  $id: ID,
  $value: String
) {
  updateProductLabelValue(
    id: $id,
    value: $value
  ) {
    id
    labelId
    productId
    value
  }
}
Variables
{"id": 4, "value": "xyz789"}
Response
{
  "data": {
    "updateProductLabelValue": {
      "id": 4,
      "labelId": 4,
      "productId": "4",
      "value": "xyz789"
    }
  }
}
Mutations

updateProductOption

Response

Returns a ProductOption

Arguments
Name Description
id - ID! Product option id
name - String New option value

Example

Query
mutation UpdateProductOption(
  $id: ID!,
  $name: String
) {
  updateProductOption(
    id: $id,
    name: $name
  ) {
    id
    name
    order
  }
}
Variables
{"id": 4, "name": "abc123"}
Response
{
  "data": {
    "updateProductOption": {
      "id": 4,
      "name": "xyz789",
      "order": 987
    }
  }
}
Mutations

updateProductVariants

Description

Update product variants.

Response

Returns [ProductVariant]

Arguments
Name Description
variants - [ProductVariantUpdateInput] Product variants data

Example

Query
mutation UpdateProductVariants($variants: [ProductVariantUpdateInput]) {
  updateProductVariants(variants: $variants) {
    color
    cost
    costCurrency
    createdAt
    currency
    customId
    id
    images
    inventoryStock
    optionValue1
    optionValue2
    optionValue3
    parent {
      ...ProductFragment
    }
    parentId
    price
    priceCurrency
    rowOrder
    rrp
    rrpCurrency
    sellWhenOos
    sku
    soldOut
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
  }
}
Variables
{"variants": [ProductVariantUpdateInput]}
Response
{
  "data": {
    "updateProductVariants": [
      {
        "color": "xyz789",
        "cost": 123.45,
        "costCurrency": "abc123",
        "createdAt": "2007-12-03T10:15:30Z",
        "currency": "xyz789",
        "customId": "abc123",
        "id": "4",
        "images": ["abc123"],
        "inventoryStock": "xyz789",
        "optionValue1": "xyz789",
        "optionValue2": "abc123",
        "optionValue3": "xyz789",
        "parent": Product,
        "parentId": 4,
        "price": 123.45,
        "priceCurrency": "abc123",
        "rowOrder": 123,
        "rrp": "xyz789",
        "rrpCurrency": "abc123",
        "sellWhenOos": false,
        "sku": "xyz789",
        "soldOut": true,
        "updatedAt": "2007-12-03T10:15:30Z",
        "urlkey": "abc123",
        "variantCustomField1": "abc123",
        "variantCustomField2": "abc123",
        "variantCustomField3": "abc123"
      }
    ]
  }
}
Mutations

updateProfile

Description

Update the user profile data

Response

Returns a User

Arguments
Name Description
user - UserInput User data for updating purposes

Example

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

updateSetting

Description

Get user settings

Response

Returns a String

Arguments
Name Description
settings - SettingInput

Example

Query
mutation UpdateSetting($settings: SettingInput) {
  updateSetting(settings: $settings)
}
Variables
{"settings": SettingInput}
Response
{"data": {"updateSetting": "abc123"}}
Mutations

updateTeamGroupName

Description

Update team group name

Response

Returns a TeamGroup

Arguments
Name Description
id - ID! ID of the team group
name - String! New name for the team group

Example

Query
mutation UpdateTeamGroupName(
  $id: ID!,
  $name: String!
) {
  updateTeamGroupName(
    id: $id,
    name: $name
  ) {
    id
    members {
      ...TeamGroupMemberFragment
    }
    name
  }
}
Variables
{
  "id": "4",
  "name": "abc123"
}
Response
{
  "data": {
    "updateTeamGroupName": {
      "id": "4",
      "members": [TeamGroupMember],
      "name": "xyz789"
    }
  }
}
Mutations

updateTeamUser

Description

Update teamUser

Response

Returns a TeamUser

Arguments
Name Description
id - ID
role - TeamRoleType

Example

Query
mutation UpdateTeamUser(
  $id: ID,
  $role: TeamRoleType
) {
  updateTeamUser(
    id: $id,
    role: $role
  ) {
    accessSuppliers {
      ...AccessContactFragment
    }
    canSeeAllContacts
    contactPermissions {
      ...ContactPermissionFragment
    }
    credential {
      ...CredFragment
    }
    credentialId
    id
    role
    userId
  }
}
Variables
{"id": 4, "role": "ADMIN"}
Response
{
  "data": {
    "updateTeamUser": {
      "accessSuppliers": [AccessContact],
      "canSeeAllContacts": true,
      "contactPermissions": [ContactPermission],
      "credential": Cred,
      "credentialId": 4,
      "id": 4,
      "role": "abc123",
      "userId": "4"
    }
  }
}
Mutations

updateUserGroup

Description

Update userGroup

Response

Returns a UserGroup

Arguments
Name Description
id - ID
name - String

Example

Query
mutation UpdateUserGroup(
  $id: ID,
  $name: String
) {
  updateUserGroup(
    id: $id,
    name: $name
  ) {
    id
    members {
      ...UserGroupMemberFragment
    }
    name
  }
}
Variables
{"id": 4, "name": "xyz789"}
Response
{
  "data": {
    "updateUserGroup": {
      "id": "4",
      "members": [UserGroupMember],
      "name": "abc123"
    }
  }
}
Mutations

updateUserProfile

Description

Update profile

Response

Returns a Credential

Arguments
Name Description
data - ProfileInput Profile data

Example

Query
mutation UpdateUserProfile($data: ProfileInput) {
  updateUserProfile(data: $data) {
    accountType
    avatar
    email
    firstName
    isAdmin
    lastName
    nlAccept
    plan {
      ...PlanFragment
    }
    recovery
    recoveryInform
    representing {
      ...UserFragment
    }
    status
    user {
      ...UserFragment
    }
    userId
    welcome
  }
}
Variables
{"data": ProfileInput}
Response
{
  "data": {
    "updateUserProfile": {
      "accountType": "BUYER",
      "avatar": "xyz789",
      "email": "abc123",
      "firstName": "xyz789",
      "isAdmin": true,
      "lastName": "xyz789",
      "nlAccept": false,
      "plan": Plan,
      "recovery": "xyz789",
      "recoveryInform": false,
      "representing": [User],
      "status": true,
      "user": User,
      "userId": 4,
      "welcome": true
    }
  }
}
Mutations

updateVariantRowOrder

Description

Update variant row_order

Response

Returns a ProductVariant

Arguments
Name Description
id - ID! Variant id
rowOrder - Int New row order

Example

Query
mutation UpdateVariantRowOrder(
  $id: ID!,
  $rowOrder: Int
) {
  updateVariantRowOrder(
    id: $id,
    rowOrder: $rowOrder
  ) {
    color
    cost
    costCurrency
    createdAt
    currency
    customId
    id
    images
    inventoryStock
    optionValue1
    optionValue2
    optionValue3
    parent {
      ...ProductFragment
    }
    parentId
    price
    priceCurrency
    rowOrder
    rrp
    rrpCurrency
    sellWhenOos
    sku
    soldOut
    updatedAt
    urlkey
    variantCustomField1
    variantCustomField2
    variantCustomField3
  }
}
Variables
{"id": 4, "rowOrder": 123}
Response
{
  "data": {
    "updateVariantRowOrder": {
      "color": "abc123",
      "cost": 123.45,
      "costCurrency": "abc123",
      "createdAt": "2007-12-03T10:15:30Z",
      "currency": "xyz789",
      "customId": "xyz789",
      "id": "4",
      "images": ["abc123"],
      "inventoryStock": "abc123",
      "optionValue1": "xyz789",
      "optionValue2": "abc123",
      "optionValue3": "abc123",
      "parent": Product,
      "parentId": "4",
      "price": 987.65,
      "priceCurrency": "xyz789",
      "rowOrder": 123,
      "rrp": "xyz789",
      "rrpCurrency": "abc123",
      "sellWhenOos": true,
      "sku": "xyz789",
      "soldOut": false,
      "updatedAt": "2007-12-03T10:15:30Z",
      "urlkey": "abc123",
      "variantCustomField1": "abc123",
      "variantCustomField2": "abc123",
      "variantCustomField3": "xyz789"
    }
  }
}
Mutations

updateWebhook

Response

Returns a Webhook

Arguments
Name Description
data - WebhookInput webhook input data
id - ID! webhook id

Example

Query
mutation UpdateWebhook(
  $data: WebhookInput,
  $id: ID!
) {
  updateWebhook(
    data: $data,
    id: $id
  ) {
    headers
    id
    owner {
      ...UserFragment
    }
    ownerId
    password
    url
    userName
    webhookEvents {
      ...WebhookEventFragment
    }
  }
}
Variables
{
  "data": WebhookInput,
  "id": "4"
}
Response
{
  "data": {
    "updateWebhook": {
      "headers": Json,
      "id": "4",
      "owner": User,
      "ownerId": 4,
      "password": "abc123",
      "url": "abc123",
      "userName": "abc123",
      "webhookEvents": [WebhookEvent]
    }
  }
}
Mutations

upsertIntegrationConfigurations

Description

Mutation for inserting or updating a list of integration_configurations

Response

Returns an Int

Arguments
Name Description
keysValues - [KeyValueInput] integration configuration keys and values
partnerIntegrationId - ID! partner_integration_id

Example

Query
mutation UpsertIntegrationConfigurations(
  $keysValues: [KeyValueInput],
  $partnerIntegrationId: ID!
) {
  upsertIntegrationConfigurations(
    keysValues: $keysValues,
    partnerIntegrationId: $partnerIntegrationId
  )
}
Variables
{
  "keysValues": [KeyValueInput],
  "partnerIntegrationId": "4"
}
Response
{"data": {"upsertIntegrationConfigurations": 123}}
Mutations

upsertProductInBackground

Description

Upsert product in a backround job.

Response

Returns a BackgroundJob

Arguments
Name Description
data - ProductInput Product input
externalProductId - ID External product id
inventoryItemId - ID Inventory item id
partnerIntegrationId - ID Partner integration id
type - String create or update. Default = "create"

Example

Query
mutation UpsertProductInBackground(
  $data: ProductInput,
  $externalProductId: ID,
  $inventoryItemId: ID,
  $partnerIntegrationId: ID,
  $type: String
) {
  upsertProductInBackground(
    data: $data,
    externalProductId: $externalProductId,
    inventoryItemId: $inventoryItemId,
    partnerIntegrationId: $partnerIntegrationId,
    type: $type
  ) {
    cartId
    completedAt
    contactId
    createdAt
    dropId
    id
    orderId
    result
    type
    updatedAt
  }
}
Variables
{
  "data": ProductInput,
  "externalProductId": "4",
  "inventoryItemId": "4",
  "partnerIntegrationId": 4,
  "type": "create"
}
Response
{
  "data": {
    "upsertProductInBackground": {
      "cartId": 4,
      "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"
    }
  }
}

Types

AccessContact

Description

Access contact

Fields
Field Name Description
accessContact - Contact Contact to which access has been granted
accessContactId - ID
accessType - Int
accessUserId - ID
contactId - ID
contactUserId - ID
ownerId - ID
Example
{
  "accessContact": Contact,
  "accessContactId": 4,
  "accessType": 123,
  "accessUserId": "4",
  "contactId": 4,
  "contactUserId": "4",
  "ownerId": 4
}
Types

AccountType

Description

Available account types

Values
Enum Value Description

BUYER

 Able to find and purchase products from sellers on the platform

SELLER

 Lists and sells products through the platform

GUEST

 Has access to public profiles and drops
Example
"BUYER"
Types

ActionResult

Fields
Field Name Description
message - String
success - Boolean
Example
{"message": "abc123", "success": false}
Types

AddToCartInput

Description

Type for accepting add to cart attributes

Fields
Input Field Description
buyerId - ID
cartId - ID
cartUrlkey - String
dropId - ID
items - [CartProductInput]
Example
{
  "buyerId": "4",
  "cartId": 4,
  "cartUrlkey": "xyz789",
  "dropId": "4",
  "items": [CartProductInput]
}
Types

Address

Fields
Field Name Description
addressLine1 - String
addressLine2 - String
city - String
company - String
country - String
description - String
email - String
firstName - String
id - ID
lastName - String
phone - String
postalCode - String
state - String
Example
{
  "addressLine1": "abc123",
  "addressLine2": "abc123",
  "city": "abc123",
  "company": "xyz789",
  "country": "xyz789",
  "description": "abc123",
  "email": "xyz789",
  "firstName": "xyz789",
  "id": "4",
  "lastName": "xyz789",
  "phone": "abc123",
  "postalCode": "xyz789",
  "state": "abc123"
}
Types

AddressFilter

Fields
Input Field Description
createdBy - IdFilter
description - String
id - IdFilter
Example
{
  "createdBy": IdFilter,
  "description": "abc123",
  "id": IdFilter
}
Types

AddressInput

Fields
Input Field Description
addressLine1 - String
addressLine2 - String
city - String
company - String
country - String
description - String
email - String
firstName - String
lastName - String
phone - String
postalCode - String
state - String
Example
{
  "addressLine1": "xyz789",
  "addressLine2": "abc123",
  "city": "abc123",
  "company": "abc123",
  "country": "xyz789",
  "description": "abc123",
  "email": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "phone": "xyz789",
  "postalCode": "xyz789",
  "state": "xyz789"
}
Types

AmountBySupplier

Fields
Field Name Description
id - ID
name - String
totalAmount - Float
totalOrderedItems - Float
Example
{
  "id": "4",
  "name": "xyz789",
  "totalAmount": 987.65,
  "totalOrderedItems": 987.65
}
Types

AmountOfMoney

Description

Amount

Fields
Field Name Description
currency - String
totalAmount - Float
Example
{
  "currency": "xyz789",
  "totalAmount": 123.45
}
Types

BackgroundJob

Description

A background_job

Fields
Field Name Description
cartId - ID
completedAt - DateTime
contactId - ID
createdAt - DateTime
dropId - ID
id - ID
orderId - ID
result - String
type - String
updatedAt - DateTime
Example
{
  "cartId": 4,
  "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"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Brand

Description

Feature that distinguishes one seller's good or service from those of other sellers

Fields
Field Name Description
id - ID
name - String
Example
{"id": 4, "name": "xyz789"}
Types

BrandModelOrder

Description

Ordering options for brand list

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

NAME_ASC

 Ascending by name

NAME_DESC

 Descending by name

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

BrandsMeta

Description

Meta data for a listBrands query

Fields
Field Name Description
count - Int Number of entries returned in a listBrands query
Example
{"count": 987}
Types

Cart

Description

A cart

Fields
Field Name Description
_cartProductsMeta - CartProductsMeta
_parentProductsMeta - CartProductsMeta
buyer - User
buyerAddresses - [Address] List of buyer addresses.
buyerId - ID
cartProducts - [CartProduct]
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
cartReminderInfo - CartReminderInfo
comment - String
createdAt - DateTime
creatorType - String
drop - Drop
dropId - ID
guestId - ID
id - ID
invoiceAddress - Address
invoiceAddressId - ID
isPrivate - Boolean
ownerId - ID
parentProducts - [CartProduct]
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0

orderBy - [CartProductModelOrder]

Order for returning products
repId - ID
seller - User
sellerId - ID
shippingAddress - Address
shippingAddressId - ID
updatedAt - DateTime
urlkey - String
Example
{
  "_cartProductsMeta": CartProductsMeta,
  "_parentProductsMeta": CartProductsMeta,
  "buyer": User,
  "buyerAddresses": [Address],
  "buyerId": "4",
  "cartProducts": [CartProduct],
  "cartReminderInfo": CartReminderInfo,
  "comment": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "creatorType": "xyz789",
  "drop": Drop,
  "dropId": 4,
  "guestId": 4,
  "id": "4",
  "invoiceAddress": Address,
  "invoiceAddressId": "4",
  "isPrivate": false,
  "ownerId": "4",
  "parentProducts": [CartProduct],
  "repId": "4",
  "seller": User,
  "sellerId": 4,
  "shippingAddress": Address,
  "shippingAddressId": 4,
  "updatedAt": "2007-12-03T10:15:30Z",
  "urlkey": "xyz789"
}
Types

CartFilter

Description

Type for accepting cart filter values

Fields
Input Field Description
buyerId - IdFilter
dropId - IdFilter
query - String
Example
{
  "buyerId": IdFilter,
  "dropId": IdFilter,
  "query": "xyz789"
}
Types

CartInput

Fields
Input Field Description
buyerId - ID
cartProducts - [CartProductInput]
comment - String
dropId - ID
guestId - ID
invoiceAddressId - ID
isPrivate - Boolean
repId - ID
shippingAddressId - ID
Example
{
  "buyerId": "4",
  "cartProducts": [CartProductInput],
  "comment": "xyz789",
  "dropId": "4",
  "guestId": 4,
  "invoiceAddressId": "4",
  "isPrivate": false,
  "repId": 4,
  "shippingAddressId": 4
}
Types

CartLabelValue

Description

cart_label_value

Fields
Field Name Description
cartId - ID
id - ID
labelId - ID
orderId - ID
value - String
Example
{
  "cartId": "4",
  "id": 4,
  "labelId": 4,
  "orderId": 4,
  "value": "abc123"
}
Types

CartLabelValueCudInput

Fields
Input Field Description
cartId - ID
cudType - CudType
id - ID
labelId - ID
orderId - ID
value - String
Example
{
  "cartId": 4,
  "cudType": "CREATE",
  "id": 4,
  "labelId": 4,
  "orderId": "4",
  "value": "abc123"
}
Types

CartLabelValueInput

Fields
Input Field Description
cartId - ID
labelId - ID
orderId - ID
value - String
Example
{
  "cartId": 4,
  "labelId": "4",
  "orderId": 4,
  "value": "xyz789"
}
Types

CartMeta

Description

Medata data for a list carts query

Fields
Field Name Description
count - Int
Example
{"count": 123}
Types

CartModelOrder

Description

Ordering options for cart lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

CartProduct

Description

A product in the cart with quantity

Fields
Field Name Description
cart - Cart
cartId - ID
id - ID
product - Product
productId - ID
quantity - Float
variants - [CartProduct] Cart Product child entries
Example
{
  "cart": Cart,
  "cartId": "4",
  "id": "4",
  "product": Product,
  "productId": 4,
  "quantity": 123.45,
  "variants": [CartProduct]
}
Types

CartProductInput

Fields
Input Field Description
productId - ID!
quantity - Float
Example
{"productId": "4", "quantity": 987.65}
Types

CartProductLabelValue

Description

cart_product_label_value

Fields
Field Name Description
cartId - ID
id - ID
labelId - ID
orderId - ID
productId - ID
value - String
Example
{
  "cartId": "4",
  "id": "4",
  "labelId": 4,
  "orderId": 4,
  "productId": "4",
  "value": "xyz789"
}
Types

CartProductLabelValueInput

Fields
Input Field Description
cartId - ID
labelId - ID
orderId - ID
productId - ID
value - String
Example
{
  "cartId": "4",
  "labelId": 4,
  "orderId": "4",
  "productId": "4",
  "value": "xyz789"
}
Types

CartProductModelOrder

Description

Ordering options for cart product lists

Values
Enum Value Description

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID
Example
"ID_ASC"
Types

CartProductsMeta

Description

Medata data for a list cart products query

Fields
Field Name Description
appliedDiscount - Float The discount applied in %
count - Int Number of products in the cart
currency - String Currency used in the the order
discountAmount - Float The discount amount in order currency
margin - Float
msrpMultiplier - Float
parentCount - Int Count of parent products
profit - Float
quantity - Float Number of product items in the cart
summary - String Cart product summary description
total - Float Total amount of the cart products after discounts applied
totalRrp - Float
Example
{
  "appliedDiscount": 987.65,
  "count": 987,
  "currency": "abc123",
  "discountAmount": 987.65,
  "margin": 123.45,
  "msrpMultiplier": 123.45,
  "parentCount": 123,
  "profit": 987.65,
  "quantity": 987.65,
  "summary": "abc123",
  "total": 123.45,
  "totalRrp": 123.45
}
Types

CartReminderInfo

Description

Cart reminder info

Fields
Field Name Description
lastSendDate - DateTime
showButton - Boolean
total - Int
Example
{
  "lastSendDate": "2007-12-03T10:15:30Z",
  "showButton": true,
  "total": 987
}
Types

ConnectRequest

Description

A request to connect on the platform

Fields
Field Name Description
acceptedAt - DateTime
createdAt - DateTime
id - ID
rejectedAt - DateTime
requesterUser - User
source - String Source leading to the connect request.
targetUser - User
term - String Identifies search terms leading to the connect request
updatedAt - DateTime
Example
{
  "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"
}
Types

ConnectRequestModelFilter

Description

Type for accepting connect request filter values

Fields
Input Field Description
acceptedAt - DatetimeFilter
rejectedAt - DatetimeFilter
requesterUserId - IdFilter
requesterUserUrlkey - UrlkeyFilter
targetUserId - IdFilter
targetUserUrlkey - UrlkeyFilter
Example
{
  "acceptedAt": DatetimeFilter,
  "rejectedAt": DatetimeFilter,
  "requesterUserId": IdFilter,
  "requesterUserUrlkey": UrlkeyFilter,
  "targetUserId": IdFilter,
  "targetUserUrlkey": UrlkeyFilter
}
Types

ConnectRequestModelOrder

Description

Ordering options for connect request lists

Values
Enum Value Description

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID
Example
"ID_ASC"
Types

Contact

Description

contact

Fields
Field Name Description
accessCustomers - [AccessContact]
accessSuppliers - [AccessContact]
address - Address
addressId - ID
blockOrdering - Boolean Block ordering for this contact
contactUser - User Contact user
contactUserId - ID
currency - String
customId - String
defaultSupplier - Int
discount - Float
email - String
emailEditable - Boolean Is email editable
id - ID
img - [String]
invite - Boolean Can the contact be invited or not
invoiceAddress - String
invoiceApartment - String
invoiceCity - String
invoiceCompany - String
invoiceCountry - String
invoiceFirstname - String
invoiceLastname - String
invoicePostalcode - String
invoiceRegion - String
isSuperman - Boolean Access to all suppliers - can sell all products. Relevant for contact type sales rep.
isSuperwoman - Boolean Access to all contacts - can sell to all customers. Relevant for contact type sales rep.
lastInvite - DateTime Last platform invite send date
listAddresses - [ContactAddress]
migrateOldId - String
name - String
notes - String
ownerId - ID
paymentBankCustom - String
paymentEmail - String
paymentIbanCustom - String
paymentMethod - String
paymentTaxCode - String
paymentVatCustom - String
phone - String
shippingAddr - Address
shippingAddress - String
shippingAddressId - ID
shippingApartment - String
shippingCity - String
shippingCompany - String
shippingCountry - String
shippingFirstname - String
shippingLastname - String
shippingPostalcode - String
shippingRegion - String
showConnectButton - Boolean Show connect button
showPaymentTaxCode - Boolean
status - Int
taxRatio - Float
termOfPayment - String
type - Int 0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member
urlkey - String
userGroups - [UserGroup]
Example
{
  "accessCustomers": [AccessContact],
  "accessSuppliers": [AccessContact],
  "address": Address,
  "addressId": 4,
  "blockOrdering": false,
  "contactUser": User,
  "contactUserId": "4",
  "currency": "abc123",
  "customId": "xyz789",
  "defaultSupplier": 123,
  "discount": 123.45,
  "email": "abc123",
  "emailEditable": true,
  "id": 4,
  "img": ["xyz789"],
  "invite": true,
  "invoiceAddress": "abc123",
  "invoiceApartment": "abc123",
  "invoiceCity": "abc123",
  "invoiceCompany": "xyz789",
  "invoiceCountry": "abc123",
  "invoiceFirstname": "xyz789",
  "invoiceLastname": "xyz789",
  "invoicePostalcode": "xyz789",
  "invoiceRegion": "xyz789",
  "isSuperman": true,
  "isSuperwoman": true,
  "lastInvite": "2007-12-03T10:15:30Z",
  "listAddresses": [ContactAddress],
  "migrateOldId": "abc123",
  "name": "abc123",
  "notes": "xyz789",
  "ownerId": 4,
  "paymentBankCustom": "xyz789",
  "paymentEmail": "abc123",
  "paymentIbanCustom": "abc123",
  "paymentMethod": "xyz789",
  "paymentTaxCode": "xyz789",
  "paymentVatCustom": "abc123",
  "phone": "xyz789",
  "shippingAddr": Address,
  "shippingAddress": "xyz789",
  "shippingAddressId": "4",
  "shippingApartment": "xyz789",
  "shippingCity": "xyz789",
  "shippingCompany": "abc123",
  "shippingCountry": "abc123",
  "shippingFirstname": "xyz789",
  "shippingLastname": "xyz789",
  "shippingPostalcode": "abc123",
  "shippingRegion": "abc123",
  "showConnectButton": false,
  "showPaymentTaxCode": true,
  "status": 123,
  "taxRatio": 123.45,
  "termOfPayment": "abc123",
  "type": 123,
  "urlkey": "xyz789",
  "userGroups": [UserGroup]
}
Types

ContactAddress

Fields
Field Name Description
address - Address
addressId - ID
contactId - ID
id - ID
Example
{
  "address": Address,
  "addressId": 4,
  "contactId": "4",
  "id": 4
}
Types

ContactFilter

Fields
Input Field Description
contactUserId - IdFilter
email - StringFilter
id - IdFilter
name - StringFilter
ownerId - IdFilter
query - String Full text search on contact entries
type - IntegerFilter 0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member
Example
{
  "contactUserId": IdFilter,
  "email": StringFilter,
  "id": IdFilter,
  "name": StringFilter,
  "ownerId": IdFilter,
  "query": "xyz789",
  "type": IntegerFilter
}
Types

ContactInput

Fields
Input Field Description
addressId - ID
blockOrdering - Boolean Block ordering for this contact
contactUserId - ID
currency - String
customId - String
defaultSupplier - Int
discount - Float
email - String
emailEditable - Boolean Is email editable
invite - Boolean Can the contact be invited or not
invoicePostalcode - String
isSuperman - SmartBoolean
isSuperwoman - SmartBoolean
lastInvite - DateTime Last platform invite send date
migrateOldId - String
name - String
notes - String
paymentBankCustom - String
paymentEmail - String
paymentIbanCustom - String
paymentMethod - String
paymentTaxCode - String
paymentVatCustom - String
phone - String
shippingAddressId - ID
shippingPostalcode - String
showConnectButton - Boolean Show connect button
showPaymentTaxCode - Boolean
status - Int
taxRatio - Float
termOfPayment - String
type - Int 0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member
urlkey - String
Example
{
  "addressId": 4,
  "blockOrdering": false,
  "contactUserId": "4",
  "currency": "abc123",
  "customId": "abc123",
  "defaultSupplier": 123,
  "discount": 987.65,
  "email": "xyz789",
  "emailEditable": false,
  "invite": true,
  "invoicePostalcode": "abc123",
  "isSuperman": SmartBoolean,
  "isSuperwoman": SmartBoolean,
  "lastInvite": "2007-12-03T10:15:30Z",
  "migrateOldId": "abc123",
  "name": "xyz789",
  "notes": "xyz789",
  "paymentBankCustom": "abc123",
  "paymentEmail": "xyz789",
  "paymentIbanCustom": "abc123",
  "paymentMethod": "xyz789",
  "paymentTaxCode": "xyz789",
  "paymentVatCustom": "xyz789",
  "phone": "xyz789",
  "shippingAddressId": 4,
  "shippingPostalcode": "abc123",
  "showConnectButton": false,
  "showPaymentTaxCode": false,
  "status": 987,
  "taxRatio": 123.45,
  "termOfPayment": "abc123",
  "type": 987,
  "urlkey": "xyz789"
}
Types

ContactLabelValue

Description

contact_label_value

Fields
Field Name Description
contactId - ID
id - ID
labelId - ID
value - String
Example
{
  "contactId": "4",
  "id": "4",
  "labelId": 4,
  "value": "abc123"
}
Types

ContactLabelValueCudInput

Fields
Input Field Description
contactId - ID
cudType - CudType
id - ID
labelId - ID
value - String
Example
{
  "contactId": 4,
  "cudType": "CREATE",
  "id": 4,
  "labelId": 4,
  "value": "abc123"
}
Types

ContactLabelValueInput

Fields
Input Field Description
contactId - ID
labelId - ID
value - String
Example
{
  "contactId": 4,
  "labelId": "4",
  "value": "abc123"
}
Types

ContactModelOrder

Description

Ordering options for contact lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by id

ID_DESC

 Descending by id

NAME_ASC

 Ascending by name

NAME_DESC

 Descending by name

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

ContactPage

Fields
Field Name Description
accessCustomers - [AccessContact]
accessSuppliers - [AccessContact]
address - Address
addressId - ID
blockOrdering - Boolean Block ordering for this contact
contactUser - User Contact user
contactUserId - ID
currency - String
customId - String
defaultSupplier - Int
discount - Float
email - String
emailEditable - Boolean Is email editable
group - Int
id - ID
img - [String]
invite - Boolean Can the contact be invited or not
invoiceAddress - String
invoiceApartment - String
invoiceCity - String
invoiceCompany - String
invoiceCountry - String
invoiceFirstname - String
invoiceLastname - String
invoicePostalcode - String
invoiceRegion - String
isSuperman - Boolean Access to all suppliers - can sell all products. Relevant for contact type sales rep.
isSuperwoman - Boolean Access to all contacts - can sell to all customers. Relevant for contact type sales rep.
lastInvite - DateTime Last platform invite send date
listAddresses - [ContactAddress]
members - [String]
migrateOldId - String
name - String
notes - String
ownerId - ID
paymentBankCustom - String
paymentEmail - String
paymentIbanCustom - String
paymentMethod - String
paymentTaxCode - String
paymentVatCustom - String
phone - String
shippingAddr - Address
shippingAddress - String
shippingAddressId - ID
shippingApartment - String
shippingCity - String
shippingCompany - String
shippingCountry - String
shippingFirstname - String
shippingLastname - String
shippingPostalcode - String
shippingRegion - String
showConnectButton - Boolean Show connect button
showPaymentTaxCode - Boolean
status - Int
taxRatio - Float
termOfPayment - String
type - Int 0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member
urlkey - String
userGroups - [UserGroup]
Example
{
  "accessCustomers": [AccessContact],
  "accessSuppliers": [AccessContact],
  "address": Address,
  "addressId": 4,
  "blockOrdering": false,
  "contactUser": User,
  "contactUserId": 4,
  "currency": "abc123",
  "customId": "abc123",
  "defaultSupplier": 987,
  "discount": 123.45,
  "email": "abc123",
  "emailEditable": false,
  "group": 123,
  "id": 4,
  "img": ["xyz789"],
  "invite": false,
  "invoiceAddress": "xyz789",
  "invoiceApartment": "xyz789",
  "invoiceCity": "abc123",
  "invoiceCompany": "xyz789",
  "invoiceCountry": "abc123",
  "invoiceFirstname": "abc123",
  "invoiceLastname": "xyz789",
  "invoicePostalcode": "abc123",
  "invoiceRegion": "abc123",
  "isSuperman": false,
  "isSuperwoman": false,
  "lastInvite": "2007-12-03T10:15:30Z",
  "listAddresses": [ContactAddress],
  "members": ["abc123"],
  "migrateOldId": "xyz789",
  "name": "xyz789",
  "notes": "xyz789",
  "ownerId": "4",
  "paymentBankCustom": "xyz789",
  "paymentEmail": "abc123",
  "paymentIbanCustom": "abc123",
  "paymentMethod": "xyz789",
  "paymentTaxCode": "abc123",
  "paymentVatCustom": "xyz789",
  "phone": "abc123",
  "shippingAddr": Address,
  "shippingAddress": "xyz789",
  "shippingAddressId": "4",
  "shippingApartment": "abc123",
  "shippingCity": "abc123",
  "shippingCompany": "xyz789",
  "shippingCountry": "abc123",
  "shippingFirstname": "xyz789",
  "shippingLastname": "xyz789",
  "shippingPostalcode": "abc123",
  "shippingRegion": "abc123",
  "showConnectButton": true,
  "showPaymentTaxCode": false,
  "status": 987,
  "taxRatio": 987.65,
  "termOfPayment": "xyz789",
  "type": 123,
  "urlkey": "xyz789",
  "userGroups": [UserGroup]
}
Types

ContactPermission

Fields
Field Name Description
contact - Contact
contactId - ID
id - ID
userGroup - UserGroup
userGroupId - ID
Example
{
  "contact": Contact,
  "contactId": "4",
  "id": "4",
  "userGroup": UserGroup,
  "userGroupId": "4"
}
Types

ContactsMeta

Fields
Field Name Description
accessCount - Int Count of elements with signed up user accounts attached
count - Int Count of elemtens in the list
Example
{"accessCount": 987, "count": 987}
Types

Country

Description

Country

Fields
Field Name Description
code - String a two-character country code following ISO 3166 https://www.iso.org/iso-3166-country-codes.html
name - String
Example
{
  "code": "abc123",
  "name": "xyz789"
}
Types

CountryInput

Fields
Input Field Description
code - String a two-character country code following ISO 3166 https://www.iso.org/iso-3166-country-codes.html
Example
{"code": "xyz789"}
Types

CreateDiscountInput

Fields
Input Field Description
active - Boolean Indicates whether discount can be used or not
applications - Int Number of times discount is currently in use
name - String Descriptive name of the discount
ownerId - ID
percentageValue - Float Discount value in % from the order amount
Example
{
  "active": true,
  "applications": 123,
  "name": "abc123",
  "ownerId": 4,
  "percentageValue": 987.65
}
Types

CreatePricelistValueInput

Fields
Input Field Description
currency - String!
productId - ID!
Example
{"currency": "abc123", "productId": 4}
Types

Cred

Fields
Field Name Description
avatar - String
email - String
firstName - String
lastName - String
status - Boolean
user - User
Example
{
  "avatar": "xyz789",
  "email": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "status": false,
  "user": User
}
Types

Credential

Description

credential

Fields
Field Name Description
accountType - AccountType
avatar - String Avatar of the user
email - String Email address used for logging in to the platform
firstName - String First name of the user
isAdmin - Boolean Indicates whether the credential holder is an admin or not
lastName - String Last name of the user
nlAccept - Boolean Has the customer subscribed to the Newsletter or not
plan - Plan Current selected account plan of the seller
recovery - String
recoveryInform - Boolean
representing - [User]
Arguments
first - Int

Number of elements to retrieve, defaults to 10

offset - Int

Number of first elements to be left out, defaults to 0
status - Boolean Indicates whether account is active or disabled
user - User user details
userId - ID
welcome - Boolean Has an welcome to the platform email been sent or not
Example
{
  "accountType": "BUYER",
  "avatar": "xyz789",
  "email": "xyz789",
  "firstName": "xyz789",
  "isAdmin": true,
  "lastName": "abc123",
  "nlAccept": false,
  "plan": Plan,
  "recovery": "xyz789",
  "recoveryInform": true,
  "representing": [User],
  "status": false,
  "user": User,
  "userId": "4",
  "welcome": true
}
Types

CudType

Values
Enum Value Description

CREATE

DELETE

UPDATE
Example
"CREATE"
Types

Dashboard

Description

dashboard

Fields
Field Name Description
cartsMeta - QuantityAndAmounts
dropsMeta - DropsInfo
ordersMeta - QuantityAndAmounts
Example
{
  "cartsMeta": QuantityAndAmounts,
  "dropsMeta": DropsInfo,
  "ordersMeta": QuantityAndAmounts
}
Types

Date

Description

The Date scalar type represents a date

Example
"2007-12-03"
Types

DateTime

Description

The DateTime scalar type represents a date and time in the UTC timezone. The DateTime appears in a JSON response as an ISO8601 formatted string, including UTC timezone ("Z"). The parsed date and time string will be converted to UTC and any UTC offset other than 0 will be rejected.

Example
"2007-12-03T10:15:30Z"
Types

DatetimeFilter

Fields
Input Field Description
eq - DateTime
exists - Boolean
gt - DateTime
lt - DateTime
Example
{
  "eq": "2007-12-03T10:15:30Z",
  "exists": false,
  "gt": "2007-12-03T10:15:30Z",
  "lt": "2007-12-03T10:15:30Z"
}
Types

Decimal

Description

A Decimal value represented as a string to preserve precision

Example
Decimal
Types

Discount

Description

discount

Fields
Field Name Description
active - Boolean Indicates whether discount can be used or not
applications - Int Number of times discount is currently in use
fixedAmountValue - Float
id - ID
name - String Descriptive name of the discount
ownerId - ID
percentageValue - Float Discount value in % from the order amount
quantityOrAmount - Int
status - Boolean Indicates whether discount is activated or not
type - Int
urlkey - ID Uniq non integer identifier of the discount
xgetyItems - String
xgetyMinimumAmount - Float
xgetyMinimumQtyItems - Float
xgetyPercentage - Float
Example
{
  "active": false,
  "applications": 123,
  "fixedAmountValue": 987.65,
  "id": "4",
  "name": "abc123",
  "ownerId": 4,
  "percentageValue": 987.65,
  "quantityOrAmount": 987,
  "status": false,
  "type": 123,
  "urlkey": 4,
  "xgetyItems": "abc123",
  "xgetyMinimumAmount": 987.65,
  "xgetyMinimumQtyItems": 123.45,
  "xgetyPercentage": 123.45
}
Types

DiscountFilter

Fields
Input Field Description
id - IdFilter
query - String Filter discounts by name
Example
{
  "id": IdFilter,
  "query": "abc123"
}
Types

DiscountInput

Fields
Input Field Description
active - Boolean Indicates whether discount can be used or not
applications - Int Number of times discount is currently in use
name - String Descriptive name of the discount
ownerId - ID
percentageValue - Float Discount value in % from the order amount
urlkey - ID Uniq non integer identifier of the discount
Example
{
  "active": true,
  "applications": 123,
  "name": "abc123",
  "ownerId": "4",
  "percentageValue": 123.45,
  "urlkey": "4"
}
Types

DiscountModelOrder

Description

Ordering options for discount lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

NAME_ASC

 Ascending by name

NAME_DESC

 Descending by name

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

DiscountsMeta

Description

Meta data for a list of discounts

Fields
Field Name Description
count - Int Number of discounts
Example
{"count": 987}
Types

Drop

Fields
Field Name Description
_dropProductsMeta - ProductsMeta Drop products metadata
Arguments
filter - ProductModelFilter

Filters to be applied on the returned objects
_products - ProductsMeta Drop product metadata
access - Int
archive - Boolean
asset - String
assets - [String]
assetsArchiveGeneratedAt - DateTime Timestamp of when the asset archive file was generated
assetsArchiveUrl - String Archive containing all Drop assets
createdAt - DateTime
csvSource - String
currencyBuy - String
deadline - DateTime Drop order collection deadline
deadlineStop - Boolean Identifies whether the deadline is strict or not - orders acceped after deadline or not
deliveryEnd - Date Expected product delivery end date. Only visible in exports.
deliveryStart - Date Expected product delivery start date. Only visible in exports.
deliveryWindow - String Informative text about the delivery window to displayed on the drop
discounts - [Discount] List of discount object added to the drop
Arguments
first - Int

Number of elements to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
discoverable - Boolean Indicates if a public drop is indexable and searchable for other users or not.
dropProducts - [DropProduct] List of products added to the drop and their order
Arguments
contactId - ID

Fetch prices according to selected contact

filter - ProductModelFilter

Filters to be applied on the returned objects

first - Int

Number of elements to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0

orderBy - [DropProductModelOrder]

Specifies the order for the returned objects
filter - Int 0 - No filter ser, (1-8) custom_field_(1-8), 9 - supplier_name
filters - [Int] List of field identifiers where (1-8) custom_field_(1-8), 9 - supplier_name
id - ID
images - [String]
img - String
info - String General description of the drop
isPublic - Boolean Is publicly accesible - without login and access grants
lastPromotion - DateTime Date and time of last promotion / share email being sent out
name - String Name of the drop
note - String
openrate - Int Statistical data for drop views
order - Int Custom order of the drop in a list view
orderItemsQty - Float
orderQty - Int
orderTotal - Float
orderTotalArray - [OrderTotal]
owner - User Owner of the drop
ownerId - String User ID of the drop owner
pdfGeneratedAt - DateTime Timestamp of when the pdf catalog was generated
pdfUrl - String Drop download as PDF catalog
public - Boolean
publicVisitorCount - Int Statistical data for drop views
rangeDropInt - String Dynamic part of a custom identifier for the drop taken from owner settings.
rangeDropText - String Static part of a custom identifier for the drop taken from owner settings.
season - String
sharedWithAll - Boolean Is shared with all contacts
status - Int 0: Not active, 1: Active, 2: Archived
supplier - Contact Product supplier for drop
supplierName - String
updatedAt - DateTime
urlkey - String Unique non sequential identifier for the drop.
Example
{
  "_dropProductsMeta": ProductsMeta,
  "_products": ProductsMeta,
  "access": 123,
  "archive": true,
  "asset": "abc123",
  "assets": ["xyz789"],
  "assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
  "assetsArchiveUrl": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "csvSource": "xyz789",
  "currencyBuy": "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": 987,
  "filters": [987],
  "id": 4,
  "images": ["xyz789"],
  "img": "xyz789",
  "info": "xyz789",
  "isPublic": false,
  "lastPromotion": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "note": "abc123",
  "openrate": 987,
  "order": 123,
  "orderItemsQty": 987.65,
  "orderQty": 987,
  "orderTotal": 123.45,
  "orderTotalArray": [OrderTotal],
  "owner": User,
  "ownerId": "abc123",
  "pdfGeneratedAt": "2007-12-03T10:15:30Z",
  "pdfUrl": "abc123",
  "public": false,
  "publicVisitorCount": 987,
  "rangeDropInt": "xyz789",
  "rangeDropText": "xyz789",
  "season": "xyz789",
  "sharedWithAll": true,
  "status": 987,
  "supplier": Contact,
  "supplierName": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "urlkey": "xyz789"
}
Types

DropDiscount

Description

Connection between drop and discount

Fields
Field Name Description
discount - Discount Drop to witch the discount is attached to
drop - Drop Drop to witch the discount is attached to
id - ID Uniq ID of the connection between Drop and Discount
Example
{
  "discount": Discount,
  "drop": Drop,
  "id": "4"
}
Types

DropFilter

Description

Type for accepting drop filter values

Fields
Input Field Description
ownerId - IdFilter
ownerUrlkey - UrlkeyFilter
query - String Full text search in name field of the drops
status - DropStatusFilter
Example
{
  "ownerId": IdFilter,
  "ownerUrlkey": UrlkeyFilter,
  "query": "abc123",
  "status": DropStatusFilter
}
Types

DropInput

Fields
Input Field Description
assets - [String]
csvSource - String
currencyBuy - String
deadline - DateTime Drop order collection deadline
deadlineStop - SmartBoolean
deliveryEnd - Date Expected product delivery end date. Only visible in exports.
deliveryStart - Date Expected product delivery start date. Only visible in exports.
deliveryWindow - String Informative text about the delivery window to displayed on the drop
discoverable - Boolean Indicates if a public drop is indexable and searchable for other users or not.
filter - Int 0 - No filter ser, (1-8) custom_field_(1-8), 9 - supplier_name
filters - [Int] List of field identifiers where (1-8) custom_field_(1-8), 9 - supplier_name
images - [String]
info - String General description of the drop
isPublic - Boolean Is publicly accesible - without login and access grants
name - String Name of the drop
note - String
order - Int Custom order of the drop in a list view
orderItemsQty - Float
orderQty - Int
orderTotal - Float
rangeDropInt - String Dynamic part of a custom identifier for the drop taken from owner settings.
rangeDropText - String Static part of a custom identifier for the drop taken from owner settings.
season - String
sharedWithAll - Boolean Is shared with all contacts
status - Int 0: Not active, 1: Active, 2: Archived
supplierId - ID
Example
{
  "assets": ["abc123"],
  "csvSource": "abc123",
  "currencyBuy": "xyz789",
  "deadline": "2007-12-03T10:15:30Z",
  "deadlineStop": SmartBoolean,
  "deliveryEnd": "2007-12-03",
  "deliveryStart": "2007-12-03",
  "deliveryWindow": "xyz789",
  "discoverable": false,
  "filter": 987,
  "filters": [123],
  "images": ["xyz789"],
  "info": "abc123",
  "isPublic": false,
  "name": "xyz789",
  "note": "xyz789",
  "order": 987,
  "orderItemsQty": 987.65,
  "orderQty": 123,
  "orderTotal": 987.65,
  "rangeDropInt": "xyz789",
  "rangeDropText": "abc123",
  "season": "xyz789",
  "sharedWithAll": false,
  "status": 987,
  "supplierId": "4"
}
Types

DropLabelValue

Description

drop_label_value

Fields
Field Name Description
dropId - ID
id - ID
labelId - ID
value - String
Example
{
  "dropId": 4,
  "id": 4,
  "labelId": "4",
  "value": "xyz789"
}
Types

DropLabelValueCudInput

Fields
Input Field Description
cudType - CudType
dropId - ID
id - ID
labelId - ID
value - String
Example
{
  "cudType": "CREATE",
  "dropId": "4",
  "id": 4,
  "labelId": "4",
  "value": "abc123"
}
Types

DropLabelValueInput

Fields
Input Field Description
dropId - ID
labelId - ID
value - String
Example
{
  "dropId": "4",
  "labelId": "4",
  "value": "abc123"
}
Types

DropMeta

Fields
Field Name Description
orderItemsQty - Float
orderQty - Int
orderTotal - Float
orderTotalArray - [OrderTotal]
productFilters - [DropProductFilter]
Example
{
  "orderItemsQty": 987.65,
  "orderQty": 987,
  "orderTotal": 987.65,
  "orderTotalArray": [OrderTotal],
  "productFilters": [DropProductFilter]
}
Types

DropModelOrder

Description

Ordering options for drop lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

ORDER_ASC

 Ascending by the custom order field

ORDER_DESC

 Descending by the custom order field

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

DropPdfTemplate

Values
Enum Value Description

BIG_IMAGES

 Big images

SMALL_IMAGES

 Small images (default)
Example
"BIG_IMAGES"
Types

DropPermission

Fields
Field Name Description
dropId - ID
id - ID
targetContact - Contact
targetContactId - ID
targetUserGroup - UserGroup
targetUserGroupId - ID
teamGroup - TeamGroup Team group that has access to the drop
teamGroupId - ID
teamUser - TeamUser Team user that has access to the drop
teamUserId - ID
Example
{
  "dropId": 4,
  "id": "4",
  "targetContact": Contact,
  "targetContactId": "4",
  "targetUserGroup": UserGroup,
  "targetUserGroupId": "4",
  "teamGroup": TeamGroup,
  "teamGroupId": 4,
  "teamUser": TeamUser,
  "teamUserId": "4"
}
Types

DropPermissionsMeta

Fields
Field Name Description
count - Int
Example
{"count": 987}
Types

DropProduct

Fields
Field Name Description
dropId - ID
id - ID A products association with a drop and it's order between other products
product - Product
productId - ID
rowOrder - Int Integer representing the product order in a list
Example
{
  "dropId": 4,
  "id": 4,
  "product": Product,
  "productId": 4,
  "rowOrder": 987
}
Types

DropProductFilter

Fields
Field Name Description
field - String Field name to filter products by
fieldDescription - String Description of the field to be filtered by
options - [DropProductFilterOption] List of available filter option values for the given field
Example
{
  "field": "xyz789",
  "fieldDescription": "xyz789",
  "options": [DropProductFilterOption]
}
Types

DropProductFilterOption

Fields
Field Name Description
id - ID Value to be passed to the filter
name - String Name of the filter option do be displayed to the user
Example
{
  "id": "4",
  "name": "abc123"
}
Types

DropProductModelOrder

Description

Ordering options for drop product lists

Values
Enum Value Description

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

ROW_ORDER_ASC

 Ascending by the custom order field

ROW_ORDER_DESC

 Descending by the custom order field
Example
"ID_ASC"
Types

DropRate

Fields
Field Name Description
dropId - ID
rate - Int
Example
{"dropId": 4, "rate": 987}
Types

DropStatus

Description

Drop status field values and their meaning

Values
Enum Value Description

INACTIVE

 Not Active

ACTIVE

 Active

ARCHIVED

 Archived
Example
"INACTIVE"
Types

DropStatusFilter

Description

Object for collecting filter arguments for field drop status

Fields
Input Field Description
eq - DropStatus
neq - DropStatus
Example
{"eq": "INACTIVE", "neq": "INACTIVE"}
Types

DropTabType

Values
Enum Value Description

ALL

 All drops

SHARED

 Shared drops

WORKSPACE

 Workspace (my) drops
Example
"ALL"
Types

DropsInfo

Description

Drops meta

Fields
Field Name Description
shared - Int
workspace - Int
Example
{"shared": 987, "workspace": 987}
Types

DropsMeta

Description

Meta data for a listDrops query

Fields
Field Name Description
count - Int Number of entries returned in a listDrops query
Example
{"count": 987}
Types

EmailLoginConfirmInput

Fields
Input Field Description
loginCode - String! Secret code delivered through email
urlkey - String! Unique non numeric identifier of the email login request
Example
{
  "loginCode": "xyz789",
  "urlkey": "abc123"
}
Types

EmailLoginConfirmation

Fields
Field Name Description
id - ID Unique internal identifier for the email login request
urlkey - String Unique external non numeric identifier for the email login request
Example
{"id": 4, "urlkey": "xyz789"}
Types

Event

Fields
Field Name Description
id - ID
payload - Json Payload of the event
type - String Type of event
Example
{
  "id": "4",
  "payload": Json,
  "type": "xyz789"
}
Types

EventFilter

Description

Type for accepting event filter values

Fields
Input Field Description
id - IdFilter
type - String
Example
{
  "id": IdFilter,
  "type": "xyz789"
}
Types

EventInput

Fields
Input Field Description
payload - Json Payload of the event
type - String Type of event
Example
{
  "payload": Json,
  "type": "abc123"
}
Types

EventModelOrder

Description

Ordering options for event lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

TYPE_ASC

 Ascending by the type field

TYPE_DESC

 Descending by the type field

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

EventsMeta

Fields
Field Name Description
count - Int
Example
{"count": 123}
Types

ExternalContact

Fields
Field Name Description
contactId - ID
externalSystemId - ID
externalSystemName - String
extra - String
partnerIntegrationId - ID
Example
{
  "contactId": 4,
  "externalSystemId": "4",
  "externalSystemName": "abc123",
  "extra": "abc123",
  "partnerIntegrationId": "4"
}
Types

ExternalContactFilter

Fields
Input Field Description
contactId - IdFilter
externalSystemId - IdFilter
externalSystemName - StringFilter
partnerIntegrationId - IdFilter
Example
{
  "contactId": IdFilter,
  "externalSystemId": IdFilter,
  "externalSystemName": StringFilter,
  "partnerIntegrationId": IdFilter
}
Types

ExternalContactInput

Fields
Input Field Description
contactId - ID
externalSystemId - ID
externalSystemName - String
extra - String
partnerIntegrationId - ID
Example
{
  "contactId": "4",
  "externalSystemId": 4,
  "externalSystemName": "abc123",
  "extra": "abc123",
  "partnerIntegrationId": 4
}
Types

ExternalOrder

Fields
Field Name Description
externalSystemId - ID
externalSystemName - String
extra - String
orderId - ID
partnerIntegrationId - ID
Example
{
  "externalSystemId": 4,
  "externalSystemName": "abc123",
  "extra": "abc123",
  "orderId": "4",
  "partnerIntegrationId": "4"
}
Types

ExternalOrderFilter

Fields
Input Field Description
externalSystemId - IdFilter
externalSystemName - StringFilter
orderId - IdFilter
partnerIntegrationId - IdFilter
Example
{
  "externalSystemId": IdFilter,
  "externalSystemName": StringFilter,
  "orderId": IdFilter,
  "partnerIntegrationId": IdFilter
}
Types

ExternalOrderInput

Fields
Input Field Description
externalSystemId - ID
externalSystemName - String
extra - String
orderId - ID
partnerIntegrationId - ID
Example
{
  "externalSystemId": "4",
  "externalSystemName": "abc123",
  "extra": "xyz789",
  "orderId": "4",
  "partnerIntegrationId": 4
}
Types

ExternalProduct

Fields
Field Name Description
externalSystemId - ID
externalSystemName - String
extra - String
partnerIntegrationId - ID
productId - ID
Example
{
  "externalSystemId": "4",
  "externalSystemName": "xyz789",
  "extra": "abc123",
  "partnerIntegrationId": "4",
  "productId": 4
}
Types

ExternalProductFilter

Fields
Input Field Description
externalSystemId - IdFilter
externalSystemName - StringFilter
partnerIntegrationId - IdFilter
productId - IdFilter
Example
{
  "externalSystemId": IdFilter,
  "externalSystemName": StringFilter,
  "partnerIntegrationId": IdFilter,
  "productId": IdFilter
}
Types

ExternalProductInput

Fields
Input Field Description
externalSystemId - ID
externalSystemName - String!
extra - String
partnerIntegrationId - ID!
productId - ID!
Example
{
  "externalSystemId": 4,
  "externalSystemName": "xyz789",
  "extra": "xyz789",
  "partnerIntegrationId": "4",
  "productId": "4"
}
Types

Feature

Fields
Field Name Description
name - String
Example
{"name": "xyz789"}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

IdFilter

Description

Object for collecting filter arguments for field of type ID

Fields
Input Field Description
eq - ID
in - [ID]
neq - ID
Example
{"eq": "4", "in": [4], "neq": 4}
Types

IndustriesMeta

Description

Meta data for a listIndustries query

Fields
Field Name Description
count - Int Number of entries returned in a listIndustries query
Example
{"count": 123}
Types

Industry

Fields
Field Name Description
id - ID
listBrands - [Brand]
Arguments
first - Int

Number of elements to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0

orderBy - [BrandModelOrder]

Options for sorting the results
name - String
Example
{
  "id": 4,
  "listBrands": [Brand],
  "name": "abc123"
}
Types

IndustryBrandFilter

Description

Type for accepting brand filter values

Fields
Input Field Description
brandId - IdFilter
industryId - IdFilter
Example
{
  "brandId": IdFilter,
  "industryId": IdFilter
}
Types

IndustryFilter

Description

Type for accepting industry filter values

Fields
Input Field Description
id - IdFilter
query - String Full text search in name field of the industries
Example
{
  "id": IdFilter,
  "query": "abc123"
}
Types

IndustryModelOrder

Description

Ordering options for industry list

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

NAME_ASC

 Ascending by name

NAME_DESC

 Descending by name

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. It is NOT compliant with the GraphQl spec, it can represent values between -(2^53 - 1) and 2^53 - 1 as specified by IEEE 754. It is kept here for backwards compatibility, prefer using the SpecCompliantInt.

Example
123
Types

IntegerFilter

Fields
Input Field Description
eq - Int
neq - Int
Example
{"eq": 123, "neq": 123}
Types

Integration

Description

integration

Fields
Field Name Description
id - ID
ownerId - ID
shopifyAdminApiAccessToken - String
shopifyApiSecretKey - String
shopifyUrl - String
Example
{
  "id": 4,
  "ownerId": "4",
  "shopifyAdminApiAccessToken": "abc123",
  "shopifyApiSecretKey": "abc123",
  "shopifyUrl": "abc123"
}
Types

IntegrationConfiguration

Description

integration_configuration

Fields
Field Name Description
id - ID id of the integration_configuration
key - String key of the partner_integration eg. admin_api_access_token
partnerIntegrationId - ID partner_integration_id
value - String value for the key
Example
{
  "id": 4,
  "key": "xyz789",
  "partnerIntegrationId": 4,
  "value": "abc123"
}
Types

IntegrationConfigurationFilter

Fields
Input Field Description
key - [String] Filtering options for integration_configuration
partnerIntegrationId - ID partner integration id
partnerIntegrationIds - IdFilter partner integration ids
Example
{
  "key": ["abc123"],
  "partnerIntegrationId": "4",
  "partnerIntegrationIds": IdFilter
}
Types

IntegrationConfigurationInput

Fields
Input Field Description
key - String key of the partner_integration eg. admin_api_access_token
partnerIntegrationId - ID partner_integration_id
value - String value for the key
Example
{
  "key": "abc123",
  "partnerIntegrationId": 4,
  "value": "xyz789"
}
Types

IntegrationData

Description

integration_data

Fields
Field Name Description
fieldName - String
value - String
Example
{
  "fieldName": "abc123",
  "value": "abc123"
}
Types

IntegrationDataInput

Fields
Input Field Description
fieldName - String
value - String
Example
{
  "fieldName": "xyz789",
  "value": "xyz789"
}
Types

IntegrationInput

Fields
Input Field Description
shopifyAdminApiAccessToken - String
shopifyApiSecretKey - String
shopifyUrl - String
Example
{
  "shopifyAdminApiAccessToken": "abc123",
  "shopifyApiSecretKey": "xyz789",
  "shopifyUrl": "abc123"
}
Types

Json

Description

The Json scalar type represents arbitrary json string data, represented as UTF-8 character sequences. The Json type is most often used to represent a free-form human-readable json string.

Example
Json
Types

KeyValueInput

Fields
Input Field Description
key - String key
value - String value
Example
{
  "key": "abc123",
  "value": "xyz789"
}
Types

Label

Description

label

Fields
Field Name Description
id - ID
name - String
objectType - String
objectTypes - [String]
public - Boolean
selectOptions - [String]
type - String
Example
{
  "id": 4,
  "name": "abc123",
  "objectType": "abc123",
  "objectTypes": ["xyz789"],
  "public": true,
  "selectOptions": ["xyz789"],
  "type": "abc123"
}
Types

LabelInput

Fields
Input Field Description
name - String
objectTypes - [LabelObjectType]
public - Boolean
selectOptions - [String]
type - String
Example
{
  "name": "abc123",
  "objectTypes": ["CART"],
  "public": false,
  "selectOptions": ["abc123"],
  "type": "xyz789"
}
Types

LabelObjectType

Values
Enum Value Description

CART

CONTACT

DROP

ORDER

PRODUCT
Example
"CART"
Types

ListConnectRequestsMeta

Description

Meta data for a list connect requests query

Fields
Field Name Description
count - Int
Example
{"count": 123}
Types

ListNotificationsMeta

Description

Metadata of a list notification query

Fields
Field Name Description
count - Int
Example
{"count": 123}
Types

LoginOptions

Fields
Input Field Description
countryCode - String
Example
{"countryCode": "abc123"}
Types

Notification

Description

A notification

Fields
Field Name Description
createdAt - DateTime
id - ID
object - NotificationObject
payload - String
seenAt - DateTime
type - String
updatedAt - DateTime
Example
{
  "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"
}
Types

NotificationFilter

Fields
Input Field Description
seenAt - DatetimeFilter
Example
{"seenAt": DatetimeFilter}
Types

NotificationObject

Description

Subject of the notification

Types
Union Types

ConnectRequest
Example
ConnectRequest
Types

OnboardingItem

Description

onboarding item

Fields
Field Name Description
completed - Boolean
description - String
id - ID
link - String
Example
{
  "completed": false,
  "description": "abc123",
  "id": 4,
  "link": "abc123"
}
Types

OnboardingMeta

Description

onboarding meta

Fields
Field Name Description
completed - Int
total - Int
Example
{"completed": 123, "total": 987}
Types

Option

Fields
Input Field Description
name - String
value - String
Example
{
  "name": "xyz789",
  "value": "abc123"
}
Types

Order

Description

A order

Fields
Field Name Description
appliedDiscountId - ID
buyer - User User account of the buyer.
buyerAddresses - [Address] List of buyer addresses.
buyerId - ID user id of the buyer
buyerName - String
cancel - Boolean
cartComment - String
comment - String
createdAt - DateTime
currency - String Currency of the order
customDiscount - String
customId - String User defined custom id
discountAmount - Float Amount of discount applied to the order.
discountType - String The source of discount
drop - Drop
dropId - ID
extraCosts - Float
id - ID
inform - Boolean inform email sent out yes/no
invoiceAddress - Address
invoiceAddressId - ID
invoiceDate - Date invoice date for the order
invoiceNo - String
isSeller - Boolean
labelsData - Json
orderExtraCosts - [OrderExtraCost]
orderMeta - OrderMeta Order meta
orderTag - String Order status with value meanings: "0" = "New" "1" = "In progress" "2" = "On hold" "3" = "Complete" "4" = "Guest order" "5" = "Shipped" "6" = "Approved"
owner - User User profile of the order owner
ownerId - ID
parentProducts - [OrderProduct]
Arguments
first - Int

Number of elements to retrieve, defaults to 25

offset - Int

Number of first elements to be left out, defaults to 0
products - [Product]
Arguments
first - Int

Number of elements to retrieve, defaults to 25

offset - Int

Number of first elements to be left out, defaults to 0
qty - Float
rangeOrderInt - String
rangeOrderText - String
rating - Int Rating of the order by the buyer.
rep - User User profile of the order sales rep
repCredential - Cred
repCredentialId - ID
repId - ID
rows - [OrderRow]
Arguments
first - Int

Number of elements to retrieve, defaults to 25

offset - Int

Number of first elements to be left out, defaults to 0
seller - User User account of the seller.
sellerId - ID
shippingAddress - Address
shippingAddressId - ID
shippingCosts - Float
showTeamMemberSalesRep - Boolean Flag for showing the new team member based sales rep.
status - Boolean Decides if order is visible in the order downloads false = disabled true = enabled
sumOfProducts - Float
supplierName - String
totalAmount - Float
updatedAt - DateTime
urlkey - String Non sequential unique identifier
vat - Float Value-added tax
Example
{
  "appliedDiscountId": 4,
  "buyer": User,
  "buyerAddresses": [Address],
  "buyerId": 4,
  "buyerName": "xyz789",
  "cancel": true,
  "cartComment": "xyz789",
  "comment": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "abc123",
  "customDiscount": "abc123",
  "customId": "xyz789",
  "discountAmount": 123.45,
  "discountType": "abc123",
  "drop": Drop,
  "dropId": 4,
  "extraCosts": 987.65,
  "id": "4",
  "inform": true,
  "invoiceAddress": Address,
  "invoiceAddressId": 4,
  "invoiceDate": "2007-12-03",
  "invoiceNo": "xyz789",
  "isSeller": true,
  "labelsData": Json,
  "orderExtraCosts": [OrderExtraCost],
  "orderMeta": OrderMeta,
  "orderTag": "xyz789",
  "owner": User,
  "ownerId": 4,
  "parentProducts": [OrderProduct],
  "products": [Product],
  "qty": 987.65,
  "rangeOrderInt": "xyz789",
  "rangeOrderText": "abc123",
  "rating": 987,
  "rep": User,
  "repCredential": Cred,
  "repCredentialId": "4",
  "repId": 4,
  "rows": [OrderRow],
  "seller": User,
  "sellerId": "4",
  "shippingAddress": Address,
  "shippingAddressId": "4",
  "shippingCosts": 123.45,
  "showTeamMemberSalesRep": false,
  "status": true,
  "sumOfProducts": 987.65,
  "supplierName": "abc123",
  "totalAmount": 987.65,
  "updatedAt": "2007-12-03T10:15:30Z",
  "urlkey": "abc123",
  "vat": 987.65
}
Types

OrderConfirmPdfTemplate

Values
Enum Value Description

BIG_IMAGES

 Big images

SMALL_IMAGES

 Small images (default)
Example
"BIG_IMAGES"
Types

OrderExtraCost

Description

order extra cost

Fields
Field Name Description
amount - Float
id - ID
name - String
taxRatio - Float
Example
{
  "amount": 987.65,
  "id": 4,
  "name": "xyz789",
  "taxRatio": 123.45
}
Types

OrderExtraCostInput

Fields
Input Field Description
amount - Float
name - OrderExtraCostType
taxRatio - Float
Example
{"amount": 123.45, "name": "SHIPPING_COST_VAT", "taxRatio": 987.65}
Types

OrderExtraCostType

Description

List of order extra cost types

Values
Enum Value Description

SHIPPING_COST_VAT

 Shipping cost vat
Example
"SHIPPING_COST_VAT"
Types

OrderFilter

Fields
Input Field Description
buyerId - IdFilter User id of the buyer
dropId - IdFilter
fromDate - DateTime Orders whose created at field is greater than or equal to this date.
id - IdFilter
orderTag - OrderTagOption
query - String
status - OrderStatusOption
toDate - DateTime Orders whose created at field is less than or equal to this date.
Example
{
  "buyerId": IdFilter,
  "dropId": IdFilter,
  "fromDate": "2007-12-03T10:15:30Z",
  "id": IdFilter,
  "orderTag": "NEW",
  "query": "abc123",
  "status": "DISABLED",
  "toDate": "2007-12-03T10:15:30Z"
}
Types

OrderInput

Fields
Input Field Description
appliedDiscountId - ID
buyerEmail - String
buyerId - ID
buyerName - String
cancel - SmartBoolean
cartComment - String
comment - String
currency - String
customDiscount - String
dropId - ID
dropName - String
dropSeason - String
extraCosts - Float
inform - SmartBoolean
informAdmin - SmartBoolean
invoiceAddressId - ID
invoiceDate - Date
invoiceNo - String
isPrivate - SmartBoolean
isSeller - Boolean
orderTag - Int
qty - Float
rangeOrderInt - String
rangeOrderText - String
repCredentialId - ID
repId - ID
sellerId - ID
shippingAddressId - ID
shippingCosts - Float
status - SmartBoolean
supplierName - String
totalAmount - Float
vat - String
Example
{
  "appliedDiscountId": "4",
  "buyerEmail": "abc123",
  "buyerId": "4",
  "buyerName": "abc123",
  "cancel": SmartBoolean,
  "cartComment": "abc123",
  "comment": "abc123",
  "currency": "xyz789",
  "customDiscount": "xyz789",
  "dropId": "4",
  "dropName": "xyz789",
  "dropSeason": "xyz789",
  "extraCosts": 987.65,
  "inform": SmartBoolean,
  "informAdmin": SmartBoolean,
  "invoiceAddressId": 4,
  "invoiceDate": "2007-12-03",
  "invoiceNo": "xyz789",
  "isPrivate": SmartBoolean,
  "isSeller": false,
  "orderTag": 987,
  "qty": 123.45,
  "rangeOrderInt": "abc123",
  "rangeOrderText": "abc123",
  "repCredentialId": "4",
  "repId": "4",
  "sellerId": "4",
  "shippingAddressId": 4,
  "shippingCosts": 987.65,
  "status": SmartBoolean,
  "supplierName": "xyz789",
  "totalAmount": 987.65,
  "vat": "abc123"
}
Types

OrderMeta

Description

order_meta

Fields
Field Name Description
margin - Float
msrpMultiplier - Float
profit - Float
totalRrp - Float
Example
{
  "margin": 987.65,
  "msrpMultiplier": 987.65,
  "profit": 123.45,
  "totalRrp": 123.45
}
Types

OrderPdfs

Values
Enum Value Description

DELIVERY_NOTE

INVOICE
Example
"DELIVERY_NOTE"
Types

OrderProduct

Description

order product

Fields
Field Name Description
price - Float
product - Product
quantity - Float
variants - [OrderProduct]
Example
{
  "price": 987.65,
  "product": Product,
  "quantity": 123.45,
  "variants": [OrderProduct]
}
Types

OrderRow

Description

A order row with data on ordered quantity, price and product

Fields
Field Name Description
id - ID
price - Float Product price at time of order
product - ProductVariant
quantity - Int
Example
{
  "id": "4",
  "price": 987.65,
  "product": ProductVariant,
  "quantity": 987
}
Types

OrderStatistics

Fields
Field Name Description
amountBySupplier - [AmountBySupplier]
totalAmount - Float
totalOrderedItems - Float
Example
{
  "amountBySupplier": [AmountBySupplier],
  "totalAmount": 987.65,
  "totalOrderedItems": 123.45
}
Types

OrderStatusOption

Description

List of potential values for the Order status field

Values
Enum Value Description

DISABLED

 Order NOT visible in downloads

ENABLED

 Order visible in downloads
Example
"DISABLED"
Types

OrderTagOption

Description

List of potential values for the Order orderTag field

Values
Enum Value Description

NEW

 New

PROGRESS

 In progress

HOLD

 On hoald

COMPLETE

 Complete

GUEST

 Guest order

SHIPPED

 Shipped

APPROVED

 Approved
Example
"NEW"
Types

OrderTotal

Fields
Field Name Description
amount - String
currency - String
Example
{
  "amount": "abc123",
  "currency": "xyz789"
}
Types

OrderingOptions

Description

Ordering options for order lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

OrdersMeta

Description

orders meta

Fields
Field Name Description
count - Int
Example
{"count": 123}
Types

PartnerIntegration

Description

partner_integration

Fields
Field Name Description
id - ID id of the partner_integration
listConfigurations - [IntegrationConfiguration] List of configuration values for given partner integration
Arguments
filter - IntegrationConfigurationFilter

Filters to be applied on the returned objects

first - Int

Number of elements to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
name - String name of the partner_integration eg. 'Brand X B2C Store'
owner - User Owner of the partner_integration
ownerId - ID owner_id of the partner_integration
type - String type of the partner_integration (eg. shopify or quickbooks)
Example
{
  "id": 4,
  "listConfigurations": [IntegrationConfiguration],
  "name": "xyz789",
  "owner": User,
  "ownerId": "4",
  "type": "xyz789"
}
Types

PartnerIntegrationFilter

Fields
Input Field Description
type - PartnerIntegrationTypeFilter Filtering options for partner_integration
Example
{"type": PartnerIntegrationTypeFilter}
Types

PartnerIntegrationInput

Fields
Input Field Description
name - String name of partner integration
type - PartnerIntegrationType type of the partner integration eg. shopify or quickbooks
Example
{"name": "xyz789", "type": "COMMON"}
Types

PartnerIntegrationType

Description

Types of available partner integrations

Values
Enum Value Description

COMMON

QUICKBOOKS

QUICKBOOKS_DEACTIVATED

SHOPIFY

SHOPIFY_DEACTIVATED
Example
"COMMON"
Types

PartnerIntegrationTypeFilter

Description

partner_integration_type filter

Fields
Input Field Description
eq - PartnerIntegrationType
in - [PartnerIntegrationType]
neq - PartnerIntegrationType
Example
{"eq": "COMMON", "in": ["COMMON"], "neq": "COMMON"}
Types

PaymentSubscription

Description

payment_subscription

Fields
Field Name Description
id - ID
stripeCustomerId - String
stripePlanName - String
stripeProductId - String
stripeSubscriptionId - String
stripeSubscriptionStatus - String
Example
{
  "id": 4,
  "stripeCustomerId": "xyz789",
  "stripePlanName": "abc123",
  "stripeProductId": "xyz789",
  "stripeSubscriptionId": "abc123",
  "stripeSubscriptionStatus": "abc123"
}
Types

PaymentSubscriptionFilter

Description

Type for accepting drop filter values

Fields
Input Field Description
id - IdFilter
stripeCustomerId - StringFilter
stripeProductId - StringFilter
stripeSubscriptionId - StringFilter
stripeSubscriptionStatus - StringFilter
Example
{
  "id": IdFilter,
  "stripeCustomerId": StringFilter,
  "stripeProductId": StringFilter,
  "stripeSubscriptionId": StringFilter,
  "stripeSubscriptionStatus": StringFilter
}
Types

PaymentSubscriptionInput

Description

payment_subscription_input

Fields
Input Field Description
stripeCustomerId - String
stripePlanName - String
stripeProductId - String
stripeSubscriptionId - String
stripeSubscriptionStatus - String
Example
{
  "stripeCustomerId": "xyz789",
  "stripePlanName": "xyz789",
  "stripeProductId": "abc123",
  "stripeSubscriptionId": "xyz789",
  "stripeSubscriptionStatus": "xyz789"
}
Types

PaymentSubscriptionModelOrder

Description

Ordering options for payment_subscription lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

Plan

Description

Account subscription plan determining features available and payment conditions

Fields
Field Name Description
accountType - String
description - String
id - ID
name - String
Example
{
  "accountType": "xyz789",
  "description": "abc123",
  "id": "4",
  "name": "abc123"
}
Types

PlanChangeRequest

Description

Plan change request

Fields
Field Name Description
acceptedAt - DateTime
acceptedBy - ID
id - ID
plan - Plan
planId - ID
userId - ID
Example
{
  "acceptedAt": "2007-12-03T10:15:30Z",
  "acceptedBy": 4,
  "id": 4,
  "plan": Plan,
  "planId": "4",
  "userId": "4"
}
Types

PlanChangeRequestFilter

Description

Available filter options for reducing bulk plan_change_request query results

Fields
Input Field Description
acceptedAt - DatetimeFilter
id - IdFilter
planId - IdFilter
Example
{
  "acceptedAt": DatetimeFilter,
  "id": IdFilter,
  "planId": IdFilter
}
Types

PlanChangeRequestModelOrder

Description

Ordering options for plan_change_request lists

Values
Enum Value Description

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID
Example
"ID_ASC"
Types

PlanFilter

Description

Available filter options for reducing bulk plan query results

Fields
Input Field Description
active - Boolean
id - IdFilter
name - StringFilter
Example
{
  "active": true,
  "id": IdFilter,
  "name": StringFilter
}
Types

PlanModelOrder

Description

Ordering options for plan lists

Values
Enum Value Description

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

NAME_ASC

 Ascending by name

NAME_DESC

 Descending by name
Example
"ID_ASC"
Types

PlansMeta

Description

Meta data for a listPlans query

Fields
Field Name Description
count - Int Number of entries returned in a listPlans query
Example
{"count": 123}
Types

PresignedPut

Description

Presigned S3 file upload url

Fields
Field Name Description
url - String
Example
{"url": "xyz789"}
Types

Price

Fields
Field Name Description
id - ID
price - Decimal
pricelistValueId - ID
product - Product
productId - ID
rrp - Decimal
Example
{
  "id": 4,
  "price": Decimal,
  "pricelistValueId": "4",
  "product": Product,
  "productId": "4",
  "rrp": Decimal
}
Types

PriceContact

Fields
Field Name Description
contactId - ID
id - ID
priceId - ID
userGroupId - ID
Example
{
  "contactId": "4",
  "id": "4",
  "priceId": 4,
  "userGroupId": "4"
}
Types

PriceContactInput

Fields
Input Field Description
contactId - ID
id - ID
priceId - ID
userGroupId - ID
Example
{
  "contactId": "4",
  "id": "4",
  "priceId": 4,
  "userGroupId": 4
}
Types

PriceInput

Fields
Input Field Description
id - ID
price - Decimal
pricelistValueId - ID
productId - ID
rrp - Decimal
Example
{
  "id": "4",
  "price": Decimal,
  "pricelistValueId": 4,
  "productId": "4",
  "rrp": Decimal
}
Types

PricelistValue

Description

pricelist_value

Fields
Field Name Description
currency - String
id - ID
priceContacts - [PriceContact]
prices - [Price]
product - Product
productId - ID
Example
{
  "currency": "xyz789",
  "id": "4",
  "priceContacts": [PriceContact],
  "prices": [Price],
  "product": Product,
  "productId": 4
}
Types

Product

Description

A product

Fields
Field Name Description
color - String Color of the product.
cost - Float
costCurrency - String
createdAt - DateTime
currency - String
customField1 - String Custom field configured in user settings
customField2 - String Custom field configured in user settings
customField3 - String Custom field configured in user settings
customField4 - String Custom field configured in user settings
customField5 - String Custom field configured in user settings
customField6 - String Custom field configured in user settings
customField7 - String Custom field configured in user settings
customField8 - String Custom field configured in user settings
customId - String User defined custom id of the product
customIdInt - String
customIdText - String
ean - String International (European) Article Number of the product
externalProducts - [ExternalProduct] List of external_products that references this product
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
id - ID
images - [String]
img - String
info - String Generic product description
inventoryStock - String
inventoryStockLimit - String
material - String
name - String Name of product
optionGroups - [ProductOptionGroup]
optionValue1 - String Custom variant value for the first configured field
optionValue2 - String Custom variant value for the second configured field
optionValue3 - String Custom variant value for the third configured field
origin - String
owner - User Owner of the product
ownerId - String User ID of the product owner
parent - Product Parent product
parentId - ID
parentOrChild - String
price - Float
productUserGroups - [ProductUserGroup] Returns paginated list of product's userGroups
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
rangeProductInt - String
rangeProductText - String
rowOrder - Int
rrp - String Business. Recommended retail price
sku - String Stock-keeping unit (SKU) is a scannable bar code
soldOut - Boolean Show if all of the product variants have been sold out or not.
source - String Source of the product. (eg. shopify)
supplier - Contact
supplierId - ID
supplierName - String
taric - String Code designed to show the various rules applying to specific products when imported into the EU
type - String
updatedAt - DateTime
urlkey - String Non sequential unique identifier
variantCustomField1 - String Custom variant value for the third configured field
variantCustomField2 - String Custom variant value for the forth configured field
variantCustomField3 - String Custom variant value for the fifth configured field
variants - [Product] Product variants if they exists
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
variantsV2 - [ProductVariant] Returns paginated list of product variants. One or more variant per product.
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
Example
{
  "color": "xyz789",
  "cost": 123.45,
  "costCurrency": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "xyz789",
  "customField1": "abc123",
  "customField2": "abc123",
  "customField3": "abc123",
  "customField4": "xyz789",
  "customField5": "abc123",
  "customField6": "abc123",
  "customField7": "abc123",
  "customField8": "xyz789",
  "customId": "xyz789",
  "customIdInt": "xyz789",
  "customIdText": "abc123",
  "ean": "xyz789",
  "externalProducts": [ExternalProduct],
  "id": 4,
  "images": ["xyz789"],
  "img": "xyz789",
  "info": "abc123",
  "inventoryStock": "xyz789",
  "inventoryStockLimit": "xyz789",
  "material": "abc123",
  "name": "abc123",
  "optionGroups": [ProductOptionGroup],
  "optionValue1": "xyz789",
  "optionValue2": "xyz789",
  "optionValue3": "abc123",
  "origin": "abc123",
  "owner": User,
  "ownerId": "abc123",
  "parent": Product,
  "parentId": "4",
  "parentOrChild": "xyz789",
  "price": 123.45,
  "productUserGroups": [ProductUserGroup],
  "rangeProductInt": "abc123",
  "rangeProductText": "xyz789",
  "rowOrder": 123,
  "rrp": "abc123",
  "sku": "xyz789",
  "soldOut": false,
  "source": "abc123",
  "supplier": Contact,
  "supplierId": "4",
  "supplierName": "abc123",
  "taric": "xyz789",
  "type": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "urlkey": "abc123",
  "variantCustomField1": "xyz789",
  "variantCustomField2": "abc123",
  "variantCustomField3": "abc123",
  "variants": [Product],
  "variantsV2": [ProductVariant]
}
Types

ProductFilter

Fields
Input Field Description
dropId - IdFilter
id - IdFilter Filter products by product id
query - String
supplierId - IdFilter
supplierName - StringFilter
Example
{
  "dropId": IdFilter,
  "id": IdFilter,
  "query": "abc123",
  "supplierId": IdFilter,
  "supplierName": StringFilter
}
Types

ProductInput

Fields
Input Field Description
color - String Color of the product.
costCurrency - String
createdAt - DateTime
currency - String
customField1 - String Custom field configured in user settings
customField2 - String Custom field configured in user settings
customField3 - String Custom field configured in user settings
customField4 - String Custom field configured in user settings
customField5 - String Custom field configured in user settings
customField6 - String Custom field configured in user settings
customField7 - String Custom field configured in user settings
customField8 - String Custom field configured in user settings
customId - String User defined custom id of the product
images - [String]
info - String Generic product description
material - String
name - String Name of product
options - [Option]
origin - String
ownerId - String User ID of the product owner
rowOrder - Int
sellWhenOos - Boolean
sku - String Stock-keeping unit (SKU) is a scannable bar code
source - String Source of the product. (eg. shopify)
supplierId - ID
taric - String Code designed to show the various rules applying to specific products when imported into the EU
type - String
Example
{
  "color": "abc123",
  "costCurrency": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "abc123",
  "customField1": "abc123",
  "customField2": "xyz789",
  "customField3": "xyz789",
  "customField4": "abc123",
  "customField5": "abc123",
  "customField6": "xyz789",
  "customField7": "abc123",
  "customField8": "abc123",
  "customId": "abc123",
  "images": ["abc123"],
  "info": "xyz789",
  "material": "abc123",
  "name": "abc123",
  "options": [Option],
  "origin": "xyz789",
  "ownerId": "xyz789",
  "rowOrder": 987,
  "sellWhenOos": false,
  "sku": "xyz789",
  "source": "abc123",
  "supplierId": "4",
  "taric": "xyz789",
  "type": "abc123"
}
Types

ProductLabelValue

Description

product_label_value

Fields
Field Name Description
id - ID
labelId - ID
productId - ID
value - String
Example
{
  "id": 4,
  "labelId": "4",
  "productId": "4",
  "value": "xyz789"
}
Types

ProductLabelValueCudInput

Fields
Input Field Description
cudType - CudType
id - ID
labelId - ID
productId - ID
value - String
Example
{
  "cudType": "CREATE",
  "id": "4",
  "labelId": 4,
  "productId": "4",
  "value": "abc123"
}
Types

ProductLabelValueInput

Fields
Input Field Description
labelId - ID
productId - ID
value - String
Example
{
  "labelId": 4,
  "productId": 4,
  "value": "xyz789"
}
Types

ProductModelFilter

Description

Filtering options for Product model elements

Fields
Input Field Description
customField1 - StringFilter
customField2 - StringFilter
customField3 - StringFilter
customField4 - StringFilter
customField5 - StringFilter
customField6 - StringFilter
customField7 - StringFilter
customField8 - StringFilter
dropId - IdFilter
id - IdFilter
query - String Full text search
supplierId - IdFilter
supplierName - StringFilter
type - StringFilter
Example
{
  "customField1": StringFilter,
  "customField2": StringFilter,
  "customField3": StringFilter,
  "customField4": StringFilter,
  "customField5": StringFilter,
  "customField6": StringFilter,
  "customField7": StringFilter,
  "customField8": StringFilter,
  "dropId": IdFilter,
  "id": IdFilter,
  "query": "xyz789",
  "supplierId": IdFilter,
  "supplierName": StringFilter,
  "type": StringFilter
}
Types

ProductModelOrder

Description

Ordering options for product lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

SEARCH_SCORE_ASC

 Ascending by full text search score

SEARCH_SCORE_DESC

 Descending by full text search score

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

ProductOption

Fields
Field Name Description
id - ID
name - String
order - Int
Example
{"id": 4, "name": "xyz789", "order": 123}
Types

ProductOptionGroup

Fields
Field Name Description
id - ID
name - String
options - [ProductOption]
Example
{
  "id": "4",
  "name": "abc123",
  "options": [ProductOption]
}
Types

ProductPriceCudInput

Fields
Input Field Description
cudType - CudType
currency - String
id - ID
priceContacts - [PriceContactInput]
prices - [PriceInput]
productId - ID
Example
{
  "cudType": "CREATE",
  "currency": "xyz789",
  "id": "4",
  "priceContacts": [PriceContactInput],
  "prices": [PriceInput],
  "productId": 4
}
Types

ProductUserGroup

Fields
Field Name Description
id - ID
userGroup - UserGroup
Example
{"id": 4, "userGroup": UserGroup}
Types

ProductVariant

Description

A product variant

Fields
Field Name Description
color - String Color of the product.
cost - Float
costCurrency - String
createdAt - DateTime
currency - String
customId - String User defined custom id of the product
id - ID
images - [String]
inventoryStock - String
optionValue1 - String Custom variant value for the first configured field
optionValue2 - String Custom variant value for the second configured field
optionValue3 - String Custom variant value for the third configured field
parent - Product Product details
parentId - ID
price - Float
priceCurrency - String
rowOrder - Int
rrp - String Business. Recommended retail price
rrpCurrency - String
sellWhenOos - Boolean
sku - String Stock-keeping unit (SKU) is a scannable bar code
soldOut - Boolean Show if have been sold out or not.
updatedAt - DateTime
urlkey - String
variantCustomField1 - String First variant custom field
variantCustomField2 - String Second variant custom field
variantCustomField3 - String Third variant custom field
Example
{
  "color": "xyz789",
  "cost": 987.65,
  "costCurrency": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "xyz789",
  "customId": "abc123",
  "id": "4",
  "images": ["abc123"],
  "inventoryStock": "abc123",
  "optionValue1": "abc123",
  "optionValue2": "abc123",
  "optionValue3": "xyz789",
  "parent": Product,
  "parentId": 4,
  "price": 123.45,
  "priceCurrency": "xyz789",
  "rowOrder": 123,
  "rrp": "abc123",
  "rrpCurrency": "xyz789",
  "sellWhenOos": false,
  "sku": "abc123",
  "soldOut": true,
  "updatedAt": "2007-12-03T10:15:30Z",
  "urlkey": "xyz789",
  "variantCustomField1": "xyz789",
  "variantCustomField2": "abc123",
  "variantCustomField3": "abc123"
}
Types

ProductVariantInput

Fields
Input Field Description
cost - Float
costCurrency - String
currency - String
customId - String User defined custom id of the product
images - [String]
inventoryStock - String
optionValue1 - String Custom variant value for the first configured field
optionValue2 - String Custom variant value for the second configured field
optionValue3 - String Custom variant value for the third configured field
parentId - ID
price - Float
priceCurrency - String
rowOrder - Int
rrp - String Business. Recommended retail price
rrpCurrency - String
sellWhenOos - Boolean
sku - String Stock-keeping unit (SKU) is a scannable bar code
urlkey - String
variantCustomField1 - String First variant custom field
variantCustomField2 - String Second variant custom field
variantCustomField3 - String Third variant custom field
Example
{
  "cost": 987.65,
  "costCurrency": "xyz789",
  "currency": "xyz789",
  "customId": "xyz789",
  "images": ["abc123"],
  "inventoryStock": "xyz789",
  "optionValue1": "xyz789",
  "optionValue2": "xyz789",
  "optionValue3": "xyz789",
  "parentId": "4",
  "price": 123.45,
  "priceCurrency": "abc123",
  "rowOrder": 987,
  "rrp": "abc123",
  "rrpCurrency": "xyz789",
  "sellWhenOos": true,
  "sku": "xyz789",
  "urlkey": "abc123",
  "variantCustomField1": "abc123",
  "variantCustomField2": "abc123",
  "variantCustomField3": "xyz789"
}
Types

ProductVariantUpdateInput

Fields
Input Field Description
cost - Float
costCurrency - String
currency - String
customId - String User defined custom id of the product
id - ID
images - [String]
inventoryStock - String
optionValue1 - String Custom variant value for the first configured field
optionValue2 - String Custom variant value for the second configured field
optionValue3 - String Custom variant value for the third configured field
parentId - ID
price - Float
priceCurrency - String
rowOrder - Int
rrp - String Business. Recommended retail price
rrpCurrency - String
sellWhenOos - Boolean
sku - String Stock-keeping unit (SKU) is a scannable bar code
urlkey - String
variantCustomField1 - String First variant custom field
variantCustomField2 - String Second variant custom field
variantCustomField3 - String Third variant custom field
Example
{
  "cost": 123.45,
  "costCurrency": "abc123",
  "currency": "abc123",
  "customId": "xyz789",
  "id": "4",
  "images": ["abc123"],
  "inventoryStock": "xyz789",
  "optionValue1": "abc123",
  "optionValue2": "xyz789",
  "optionValue3": "abc123",
  "parentId": "4",
  "price": 987.65,
  "priceCurrency": "abc123",
  "rowOrder": 123,
  "rrp": "xyz789",
  "rrpCurrency": "abc123",
  "sellWhenOos": true,
  "sku": "xyz789",
  "urlkey": "abc123",
  "variantCustomField1": "xyz789",
  "variantCustomField2": "xyz789",
  "variantCustomField3": "abc123"
}
Types

ProductsMeta

Fields
Field Name Description
count - Int
Example
{"count": 123}
Types

ProfileInput

Fields
Input Field Description
avatar - String Avatar of the user
firstName - String First name of the user
lastName - String Last name of the user
Example
{
  "avatar": "abc123",
  "firstName": "abc123",
  "lastName": "xyz789"
}
Types

QuantityAndAmounts

Description

Quantity and amounts

Fields
Field Name Description
count - Int
quantity - Float
totalAmounts - [AmountOfMoney]
Example
{
  "count": 123,
  "quantity": 123.45,
  "totalAmounts": [AmountOfMoney]
}
Types

QuickbooksIntegrationData

Fields
Field Name Description
doNotSyncProductDescription - Boolean
doNotUpdateProducts - Boolean
isActive - Boolean
isEstimate - Boolean
meAsAContactId - String
salesRepFieldId - String
salesRepFieldName - String
syncNotOrderedVariants - Boolean
syncOrders - Boolean
Example
{
  "doNotSyncProductDescription": true,
  "doNotUpdateProducts": true,
  "isActive": true,
  "isEstimate": false,
  "meAsAContactId": "xyz789",
  "salesRepFieldId": "abc123",
  "salesRepFieldName": "abc123",
  "syncNotOrderedVariants": true,
  "syncOrders": false
}
Types

Referral

Description

A webhook

Fields
Field Name Description
createdAt - DateTime
id - ID
numberOfPayments - Int
referred - User
type - String
updatedAt - DateTime
Example
{
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "numberOfPayments": 123,
  "referred": User,
  "type": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

ReferralModelOrder

Description

Ordering options for referral list

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

TYPE_ASC

 Ascending by type

TYPE_DESC

 Descending by type

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

ReferralsMeta

Description

Meta data for a listReferrals query

Fields
Field Name Description
count - Int Number of entries returned in a listReferrals query
Example
{"count": 987}
Types

ReportType

Description

Report type

Values
Enum Value Description

ORDERS_OVERVIEW

 Orders overview
Example
"ORDERS_OVERVIEW"
Types

SearchItem

Description

Searchable items

Values
Enum Value Description

CONTACTS

PRODUCTS
Example
"CONTACTS"
Types

Session

Description

Representation of an users session in the app

Fields
Field Name Description
id - ID
user - User
Example
{
  "id": "4",
  "user": User
}
Types

Setting

Description

setting

Fields
Field Name Description
address - Address
addressAddress - String
addressApartment - String
addressCity - String
addressCompany - String
addressCountry - String
addressFirstname - String
addressId - ID
addressLastname - String
addressPostalcode - String
autoConnect - Boolean Indicates if the user wants to automatically connect to other users or not.
bankIdentifierCode - String
chamberOfCommerceNo - String
country - Country
currency - String
customAttach - Int
customField1Name - String
customField1Status - Int
customField2Name - String
customField2Status - Int
customField3Name - String
customField3Status - Int
customField4Name - String
customField4Status - Int
customField5Name - String
customField5Status - Int
customField6Name - String
customField6Status - Int
customField7Name - String
customField7Status - Int
customField8Name - String
customField8Status - Int
customInventory - Int
customInvite - String
customInviteSubject - String
customOption1Name - String
customOption1Status - Int
customOption2Name - String
customOption2Status - Int
customOption3Name - String
customOption3Status - Int
customOption4Status - Int
customOption5Status - Int
customPreorder - Int
customSeperator - Int
customThankyou - String
customUpdate - String
defaultDropTab - String
dropPdfTemplate - String
fromCsv - Boolean
fromEmail - String
fromMessage - String
fromPdf - Boolean
fromSubject - String
includeTermsInOrderPdf - Boolean
industries - [String]
integrationToken - Token
integrationTokenId - ID integration token id
invoiceText - String
orderConfirmPdfTemplate - String
ownerId - ID
parentVariantCombine - Boolean
paymentBank - String
paymentIban - String
paymentVat - String
rangeDropInt - String
rangeDropText - String
rangeOrderInt - String
rangeOrderText - String
rangeProductInt - String
rangeProductText - String
rangeSupplierInt - String
rangeSupplierText - String
shippingAddress - Address
shippingAddressId - ID
showInDashboard - Boolean
termsAndConditions - String
termsAndConditionsRequired - Boolean
variantCustomField1Name - String
variantCustomField2Name - String
variantCustomField3Name - String
Example
{
  "address": Address,
  "addressAddress": "xyz789",
  "addressApartment": "xyz789",
  "addressCity": "xyz789",
  "addressCompany": "xyz789",
  "addressCountry": "abc123",
  "addressFirstname": "xyz789",
  "addressId": "4",
  "addressLastname": "abc123",
  "addressPostalcode": "xyz789",
  "autoConnect": false,
  "bankIdentifierCode": "abc123",
  "chamberOfCommerceNo": "abc123",
  "country": Country,
  "currency": "abc123",
  "customAttach": 123,
  "customField1Name": "abc123",
  "customField1Status": 987,
  "customField2Name": "abc123",
  "customField2Status": 123,
  "customField3Name": "abc123",
  "customField3Status": 123,
  "customField4Name": "abc123",
  "customField4Status": 987,
  "customField5Name": "xyz789",
  "customField5Status": 123,
  "customField6Name": "abc123",
  "customField6Status": 123,
  "customField7Name": "abc123",
  "customField7Status": 123,
  "customField8Name": "abc123",
  "customField8Status": 123,
  "customInventory": 123,
  "customInvite": "abc123",
  "customInviteSubject": "abc123",
  "customOption1Name": "abc123",
  "customOption1Status": 123,
  "customOption2Name": "abc123",
  "customOption2Status": 123,
  "customOption3Name": "abc123",
  "customOption3Status": 123,
  "customOption4Status": 987,
  "customOption5Status": 123,
  "customPreorder": 123,
  "customSeperator": 987,
  "customThankyou": "xyz789",
  "customUpdate": "xyz789",
  "defaultDropTab": "xyz789",
  "dropPdfTemplate": "xyz789",
  "fromCsv": false,
  "fromEmail": "xyz789",
  "fromMessage": "xyz789",
  "fromPdf": true,
  "fromSubject": "abc123",
  "includeTermsInOrderPdf": false,
  "industries": ["abc123"],
  "integrationToken": Token,
  "integrationTokenId": 4,
  "invoiceText": "xyz789",
  "orderConfirmPdfTemplate": "xyz789",
  "ownerId": "4",
  "parentVariantCombine": false,
  "paymentBank": "xyz789",
  "paymentIban": "xyz789",
  "paymentVat": "xyz789",
  "rangeDropInt": "abc123",
  "rangeDropText": "xyz789",
  "rangeOrderInt": "abc123",
  "rangeOrderText": "xyz789",
  "rangeProductInt": "abc123",
  "rangeProductText": "xyz789",
  "rangeSupplierInt": "abc123",
  "rangeSupplierText": "xyz789",
  "shippingAddress": Address,
  "shippingAddressId": 4,
  "showInDashboard": true,
  "termsAndConditions": "xyz789",
  "termsAndConditionsRequired": false,
  "variantCustomField1Name": "abc123",
  "variantCustomField2Name": "abc123",
  "variantCustomField3Name": "xyz789"
}
Types

SettingInput

Fields
Input Field Description
addressId - ID
autoConnect - Boolean Indicates if the user wants to automatically connect to other users or not.
bankIdentifierCode - String
chamberOfCommerceNo - String
country - CountryInput
currency - String
customAttach - Int
customField1Name - String
customField1Status - Int
customField2Name - String
customField2Status - Int
customField3Name - String
customField3Status - Int
customField4Name - String
customField4Status - Int
customField5Name - String
customField5Status - Int
customField6Name - String
customField6Status - Int
customField7Name - String
customField7Status - Int
customField8Name - String
customField8Status - Int
customInventory - Int
customInvite - String
customInviteSubject - String
customOption1Name - String
customOption1Status - Int
customOption2Name - String
customOption2Status - Int
customOption3Name - String
customOption3Status - Int
customOption4Status - Int
customOption5Status - Int
customSeperator - Int
customUpdate - String
defaultDropTab - DropTabType
dropPdfTemplate - DropPdfTemplate
fromCsv - SmartBoolean
fromEmail - String
fromMessage - String
fromPdf - SmartBoolean
fromSubject - String
includeTermsInOrderPdf - Boolean
industries - [String]
integrationTokenId - ID integration token id
invoiceText - String
orderConfirmPdfTemplate - OrderConfirmPdfTemplate
ownerId - ID
parentVariantCombine - Boolean
paymentBank - String
paymentIban - String
paymentVat - String
rangeDropInt - String
rangeDropText - String
rangeOrderInt - String
rangeOrderText - String
rangeProductInt - String
rangeProductText - String
rangeSupplierInt - String
rangeSupplierText - String
shippingAddressId - ID
showInDashboard - SmartBoolean
termsAndConditions - String
termsAndConditionsRequired - Boolean
variantCustomField1Name - String
variantCustomField2Name - String
variantCustomField3Name - String
Example
{
  "addressId": 4,
  "autoConnect": true,
  "bankIdentifierCode": "abc123",
  "chamberOfCommerceNo": "xyz789",
  "country": CountryInput,
  "currency": "abc123",
  "customAttach": 123,
  "customField1Name": "abc123",
  "customField1Status": 987,
  "customField2Name": "xyz789",
  "customField2Status": 123,
  "customField3Name": "xyz789",
  "customField3Status": 987,
  "customField4Name": "abc123",
  "customField4Status": 987,
  "customField5Name": "abc123",
  "customField5Status": 123,
  "customField6Name": "xyz789",
  "customField6Status": 987,
  "customField7Name": "xyz789",
  "customField7Status": 123,
  "customField8Name": "abc123",
  "customField8Status": 987,
  "customInventory": 987,
  "customInvite": "abc123",
  "customInviteSubject": "xyz789",
  "customOption1Name": "abc123",
  "customOption1Status": 987,
  "customOption2Name": "xyz789",
  "customOption2Status": 123,
  "customOption3Name": "xyz789",
  "customOption3Status": 123,
  "customOption4Status": 123,
  "customOption5Status": 123,
  "customSeperator": 987,
  "customUpdate": "xyz789",
  "defaultDropTab": "ALL",
  "dropPdfTemplate": "BIG_IMAGES",
  "fromCsv": SmartBoolean,
  "fromEmail": "xyz789",
  "fromMessage": "xyz789",
  "fromPdf": SmartBoolean,
  "fromSubject": "xyz789",
  "includeTermsInOrderPdf": true,
  "industries": ["xyz789"],
  "integrationTokenId": "4",
  "invoiceText": "xyz789",
  "orderConfirmPdfTemplate": "BIG_IMAGES",
  "ownerId": "4",
  "parentVariantCombine": true,
  "paymentBank": "abc123",
  "paymentIban": "xyz789",
  "paymentVat": "abc123",
  "rangeDropInt": "xyz789",
  "rangeDropText": "abc123",
  "rangeOrderInt": "abc123",
  "rangeOrderText": "xyz789",
  "rangeProductInt": "abc123",
  "rangeProductText": "xyz789",
  "rangeSupplierInt": "abc123",
  "rangeSupplierText": "abc123",
  "shippingAddressId": 4,
  "showInDashboard": SmartBoolean,
  "termsAndConditions": "abc123",
  "termsAndConditionsRequired": false,
  "variantCustomField1Name": "xyz789",
  "variantCustomField2Name": "abc123",
  "variantCustomField3Name": "abc123"
}
Types

ShareDropInput

Fields
Input Field Description
allContacts - Boolean share the drop with all contacts
groupIds - [ID] list of group ids for sharing the drop
individuals - [ID] list of contact ids for sharing the drop
message - String! Message to be shared with the drop
sendMeACopy - Boolean Should the sender receive a copy of the email.
Example
{
  "allContacts": false,
  "groupIds": [4],
  "individuals": [4],
  "message": "abc123",
  "sendMeACopy": true
}
Types

SharedSetting

Description

shared setting

Fields
Field Name Description
termsAndConditions - String
Example
{"termsAndConditions": "xyz789"}
Types

ShopifyIntegration

Fields
Field Name Description
alreadyRegistered - String already registered
redirectUri - String redirectUri
Example
{
  "alreadyRegistered": "abc123",
  "redirectUri": "abc123"
}
Types

ShopifyIntegrationData

Fields
Field Name Description
isActive - Boolean
orderFinancialStatus - String
orderSyncStatus - String
productsSynced - Boolean
syncActiveInventory - Boolean
syncCostAsPrice - Boolean
syncDraftInventory - Boolean
syncOrderUpdates - Boolean
syncOrders - Boolean
syncPriceAndRrp - Boolean
webhooksActivated - Boolean
Example
{
  "isActive": false,
  "orderFinancialStatus": "abc123",
  "orderSyncStatus": "xyz789",
  "productsSynced": true,
  "syncActiveInventory": false,
  "syncCostAsPrice": false,
  "syncDraftInventory": false,
  "syncOrderUpdates": false,
  "syncOrders": false,
  "syncPriceAndRrp": false,
  "webhooksActivated": false
}
Types

SignupConfirmInput

Fields
Input Field Description
confirmCode - String! Secret code delivered through email.
urlkey - String! Unique non numeric identifier of the signup.
Example
{
  "confirmCode": "abc123",
  "urlkey": "xyz789"
}
Types

SignupConfirmation

Fields
Field Name Description
accountType - AccountType Type of the user account
id - ID Unique internal identifier for the signup confirmation
urlkey - String Unique external non numeric identifier for the signup confirmation
Example
{
  "accountType": "BUYER",
  "id": 4,
  "urlkey": "xyz789"
}
Types

SignupInput

Fields
Input Field Description
acceptNewsletter - Boolean Optionally subscribe to the Order41 Newsletter to be informed about all the new and great things in the B2B sales space.
acceptTerms - Boolean! For using Order41 you have to accept the terms of service https://order41.com/terms-of-service
accountType - AccountType
connection - String Auto connect user urlkey - if there is any
email - String! Email associated with the new account
inviter - String Inviter user urlkey - if there is any
name - String Name associated with the new account
password - String! Password to be used for login
Example
{
  "acceptNewsletter": false,
  "acceptTerms": false,
  "accountType": "BUYER",
  "connection": "xyz789",
  "email": "abc123",
  "inviter": "xyz789",
  "name": "abc123",
  "password": "xyz789"
}
Types

SmartBoolean

Description

The SmartBoolean scalar type represents a boolean. And is capable of interpretting 1 and 0 representations of Boolean.

Example
SmartBoolean
Types

SpreadsheetItem

Description

A value that could be a string, integer, or float

Example
SpreadsheetItem
Types

SpreadsheetType

Values
Enum Value Description

CSV

EXCEL
Example
"CSV"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

StringFilter

Description

Object for collecting filter arguments for field of type String

Fields
Input Field Description
eq - String
in - [String]
neq - String
Example
{
  "eq": "xyz789",
  "in": ["xyz789"],
  "neq": "xyz789"
}
Types

SubscriptionDetails

Fields
Field Name Description
cardBrand - String
cardLast4 - String
currency - String
email - String
nextPaymentDate - String
price - Float
subscribed - Boolean
Example
{
  "cardBrand": "xyz789",
  "cardLast4": "xyz789",
  "currency": "xyz789",
  "email": "abc123",
  "nextPaymentDate": "abc123",
  "price": 123.45,
  "subscribed": false
}
Types

TeamGroup

Description

team_group

Fields
Field Name Description
id - ID
members - [TeamGroupMember]
name - String
Example
{
  "id": 4,
  "members": [TeamGroupMember],
  "name": "xyz789"
}
Types

TeamGroupFilter

Description

Type for accepting team group filter values

Fields
Input Field Description
query - String Full text search in name field of the team groups
Example
{"query": "xyz789"}
Types

TeamGroupMember

Fields
Field Name Description
id - ID
teamGroup - TeamGroup
teamGroupId - ID
teamUser - TeamUser
teamUserId - ID
Example
{
  "id": "4",
  "teamGroup": TeamGroup,
  "teamGroupId": "4",
  "teamUser": TeamUser,
  "teamUserId": "4"
}
Types

TeamRoleType

Description

List of team roles

Values
Enum Value Description

ADMIN

 Admin

SALES_REP

 Sales Representative

SALES_REP_LIGHT

 Sales Representative without contact actions
Example
"ADMIN"
Types

TeamUser

Fields
Field Name Description
accessSuppliers - [AccessContact]
canSeeAllContacts - Boolean
contactPermissions - [ContactPermission]
credential - Cred
credentialId - ID
id - ID
role - String
userId - ID
Example
{
  "accessSuppliers": [AccessContact],
  "canSeeAllContacts": true,
  "contactPermissions": [ContactPermission],
  "credential": Cred,
  "credentialId": 4,
  "id": 4,
  "role": "xyz789",
  "userId": 4
}
Types

TeamUserFilter

Fields
Input Field Description
query - String
role - TeamRoleType
roles - [TeamRoleType]
Example
{
  "query": "xyz789",
  "role": "ADMIN",
  "roles": ["ADMIN"]
}
Types

TeamUserModelOrder

Description

Ordering options for drop lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

TeamUsersMeta

Fields
Field Name Description
count - Int
Example
{"count": 987}
Types

TemplateType

Values
Enum Value Description

BIG_IMAGES

SMALL_IMAGES
Example
"BIG_IMAGES"
Types

Token

Description

Token

Fields
Field Name Description
comment - String
id - ID
isValid - Boolean
ownerId - ID
type - String
userId - Int
value - String
Example
{
  "comment": "abc123",
  "id": 4,
  "isValid": false,
  "ownerId": "4",
  "type": "abc123",
  "userId": 123,
  "value": "abc123"
}
Types

UpdatePricelistValueInput

Fields
Input Field Description
currency - String!
Example
{"currency": "xyz789"}
Types

UpdateProductInput

Fields
Input Field Description
costCurrency - String
currency - String
customField1 - String Custom field configured in user settings
customField2 - String Custom field configured in user settings
customField3 - String Custom field configured in user settings
customField4 - String Custom field configured in user settings
customField5 - String Custom field configured in user settings
customField6 - String Custom field configured in user settings
customField7 - String Custom field configured in user settings
customField8 - String Custom field configured in user settings
images - [String]
info - String Generic product description
material - String
name - String Name of product
origin - String
sku - String Stock-keeping unit (SKU) is a scannable bar code
supplierId - ID
taric - String Code designed to show the various rules applying to specific products when imported into the EU
type - String
Example
{
  "costCurrency": "abc123",
  "currency": "xyz789",
  "customField1": "xyz789",
  "customField2": "abc123",
  "customField3": "xyz789",
  "customField4": "abc123",
  "customField5": "xyz789",
  "customField6": "xyz789",
  "customField7": "abc123",
  "customField8": "abc123",
  "images": ["xyz789"],
  "info": "abc123",
  "material": "abc123",
  "name": "abc123",
  "origin": "abc123",
  "sku": "abc123",
  "supplierId": 4,
  "taric": "xyz789",
  "type": "xyz789"
}
Types

Url

Fields
Field Name Description
url - String
Example
{"url": "abc123"}
Types

UrlkeyFilter

Description

Object for collecting filter arguments for field of type urlkey

Fields
Input Field Description
eq - String
neq - String
Example
{
  "eq": "xyz789",
  "neq": "xyz789"
}
Types

User

Description

Object representing a platform user

Fields
Field Name Description
canSearch - Boolean
contacts - [Contact]
Arguments
first - Int

Number of elemts to retrieve, defaults to 10

offset - Int

Number of first elements to be left out, defaults to 0
discoverable - Boolean Indicates if a user is searchable for other users or not.
displayName - String User or contact name based according to current user
emailProfile - String
facebook - String
id - ID
image - String
imageMood - String
images - [String]
img - [String]
imgMood - [String]
info - String
instagram - String
name - String
phone - String
plans - [UserPlan] Account subscription plans
setting - Setting User account configuration options
teamUserRole - String
twitter - String
url - String
urlName - String
urlkey - String
Example
{
  "canSearch": true,
  "contacts": [Contact],
  "discoverable": false,
  "displayName": "abc123",
  "emailProfile": "abc123",
  "facebook": "xyz789",
  "id": 4,
  "image": "xyz789",
  "imageMood": "xyz789",
  "images": ["xyz789"],
  "img": ["abc123"],
  "imgMood": ["abc123"],
  "info": "xyz789",
  "instagram": "abc123",
  "name": "xyz789",
  "phone": "xyz789",
  "plans": [UserPlan],
  "setting": Setting,
  "teamUserRole": "abc123",
  "twitter": "xyz789",
  "url": "xyz789",
  "urlName": "xyz789",
  "urlkey": "xyz789"
}
Types

UserGroup

Fields
Field Name Description
id - ID
members - [UserGroupMember]
Arguments
first - Int

Number of elements to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
name - String
Example
{
  "id": 4,
  "members": [UserGroupMember],
  "name": "xyz789"
}
Types

UserGroupFilter

Fields
Input Field Description
id - IdFilter
name - String
Example
{
  "id": IdFilter,
  "name": "abc123"
}
Types

UserGroupMember

Fields
Field Name Description
contact - Contact
contactId - ID
id - ID
userGroupId - ID
Example
{
  "contact": Contact,
  "contactId": "4",
  "id": "4",
  "userGroupId": "4"
}
Types

UserGroupModelOrder

Description

Ordering options for userGroup lists

Values
Enum Value Description

CREATED_AT_ASC

 Ascending by created_at

CREATED_AT_DESC

 Descending by created_at

ID_ASC

 Ascending by ID

ID_DESC

 Descending by ID

NAME_ASC

 Ascending by name

NAME_DESC

 Descending by name

UPDATED_AT_ASC

 Ascending by updated_at

UPDATED_AT_DESC

 Descending by updated_at
Example
"CREATED_AT_ASC"
Types

UserGroupsMeta

Fields
Field Name Description
count - Int
Example
{"count": 987}
Types

UserInput

Fields
Input Field Description
canSearch - Boolean
discoverable - Boolean Indicates if a user is searchable for other users or not.
displayName - String User or contact name based according to current user
emailProfile - String
facebook - String
image - String
imageMood - String
info - String
instagram - String
name - String
phone - String
teamUserRole - String
twitter - String
url - String
urlName - String
urlkey - String
Example
{
  "canSearch": true,
  "discoverable": true,
  "displayName": "xyz789",
  "emailProfile": "xyz789",
  "facebook": "xyz789",
  "image": "xyz789",
  "imageMood": "abc123",
  "info": "abc123",
  "instagram": "xyz789",
  "name": "abc123",
  "phone": "xyz789",
  "teamUserRole": "abc123",
  "twitter": "abc123",
  "url": "xyz789",
  "urlName": "abc123",
  "urlkey": "xyz789"
}
Types

UserPlan

Description

User and subscription plan connection

Fields
Field Name Description
id - ID
name - String User account plan name - helper for accessing plan.name
plan - Plan Subscription plan
stripeProductId - String Stripe user subscription product id
stripeSubscriptionId - String Stripe user subscription plan id
user - User System user
Example
{
  "id": "4",
  "name": "abc123",
  "plan": Plan,
  "stripeProductId": "abc123",
  "stripeSubscriptionId": "abc123",
  "user": User
}
Types

UserProduct

Fields
Field Name Description
color - String Color of the product.
cost - Float
costCurrency - String
createdAt - DateTime
currency - String
customField1 - String Custom field configured in user settings
customField2 - String Custom field configured in user settings
customField3 - String Custom field configured in user settings
customField4 - String Custom field configured in user settings
customField5 - String Custom field configured in user settings
customField6 - String Custom field configured in user settings
customField7 - String Custom field configured in user settings
customField8 - String Custom field configured in user settings
customId - String User defined custom id of the product
customIdInt - String
customIdText - String
ean - String International (European) Article Number of the product
externalProducts - [ExternalProduct] List of external_products that references this product
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
id - ID
images - [String]
img - [String]
info - String Generic product description
inventoryStock - String
inventoryStockLimit - String
material - String
name - String Name of product
optionGroups - [ProductOptionGroup]
optionValue1 - String Custom variant value for the first configured field
optionValue2 - String Custom variant value for the second configured field
optionValue3 - String Custom variant value for the third configured field
origin - String
owner - User Owner of the product
ownerId - String User ID of the product owner
parent - Product Parent product
parentId - ID
parentOrChild - String
price - Float
productUserGroups - [ProductUserGroup] Returns paginated list of product's userGroups
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
rangeProductInt - String
rangeProductText - String
rowOrder - Int
rrp - String Business. Recommended retail price
sku - String Stock-keeping unit (SKU) is a scannable bar code
soldOut - Boolean Show if all of the product variants have been sold out or not.
source - String Source of the product. (eg. shopify)
supplier - Contact
supplierId - ID
supplierName - String
taric - String Code designed to show the various rules applying to specific products when imported into the EU
type - String
updatedAt - DateTime
urlkey - String Non sequential unique identifier
variantCustomField1 - String Custom variant value for the third configured field
variantCustomField2 - String Custom variant value for the forth configured field
variantCustomField3 - String Custom variant value for the fifth configured field
variants - [Product] Product variants if they exists
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
variantsV2 - [ProductVariant] Returns paginated list of product variants. One or more variant per product.
Arguments
first - Int

Number of elemts to retrieve, defaults to 100

offset - Int

Number of first elements to be left out, defaults to 0
Example
{
  "color": "xyz789",
  "cost": 987.65,
  "costCurrency": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "currency": "abc123",
  "customField1": "abc123",
  "customField2": "xyz789",
  "customField3": "xyz789",
  "customField4": "xyz789",
  "customField5": "xyz789",
  "customField6": "abc123",
  "customField7": "abc123",
  "customField8": "abc123",
  "customId": "xyz789",
  "customIdInt": "abc123",
  "customIdText": "abc123",
  "ean": "xyz789",
  "externalProducts": [ExternalProduct],
  "id": 4,
  "images": ["xyz789"],
  "img": ["xyz789"],
  "info": "xyz789",
  "inventoryStock": "abc123",
  "inventoryStockLimit": "xyz789",
  "material": "abc123",
  "name": "abc123",
  "optionGroups": [ProductOptionGroup],
  "optionValue1": "abc123",
  "optionValue2": "xyz789",
  "optionValue3": "xyz789",
  "origin": "xyz789",
  "owner": User,
  "ownerId": "xyz789",
  "parent": Product,
  "parentId": "4",
  "parentOrChild": "abc123",
  "price": 123.45,
  "productUserGroups": [ProductUserGroup],
  "rangeProductInt": "xyz789",
  "rangeProductText": "xyz789",
  "rowOrder": 123,
  "rrp": "abc123",
  "sku": "xyz789",
  "soldOut": false,
  "source": "abc123",
  "supplier": Contact,
  "supplierId": 4,
  "supplierName": "abc123",
  "taric": "xyz789",
  "type": "xyz789",
  "updatedAt": "2007-12-03T10:15:30Z",
  "urlkey": "xyz789",
  "variantCustomField1": "xyz789",
  "variantCustomField2": "abc123",
  "variantCustomField3": "abc123",
  "variants": [Product],
  "variantsV2": [ProductVariant]
}
Types

Webhook

Description

A webhook

Fields
Field Name Description
headers - Json
id - ID
owner - User
ownerId - ID
password - String
url - String
userName - String
webhookEvents - [WebhookEvent]
Example
{
  "headers": Json,
  "id": "4",
  "owner": User,
  "ownerId": "4",
  "password": "xyz789",
  "url": "abc123",
  "userName": "abc123",
  "webhookEvents": [WebhookEvent]
}
Types

WebhookEvent

Description

webhook event

Fields
Field Name Description
eventType - String
id - ID
objectType - String
webhookId - ID
Example
{
  "eventType": "xyz789",
  "id": 4,
  "objectType": "abc123",
  "webhookId": 4
}
Types

WebhookEventInput

Fields
Input Field Description
eventType - String
id - ID
objectType - String
Example
{
  "eventType": "xyz789",
  "id": 4,
  "objectType": "xyz789"
}
Types

WebhookInput

Fields
Input Field Description
headers - Json
password - String
url - String
userName - String
webhookEvents - [WebhookEventInput]
Example
{
  "headers": Json,
  "password": "xyz789",
  "url": "xyz789",
  "userName": "abc123",
  "webhookEvents": [WebhookEventInput]
}
Documentation by Anvil SpectaQL