API Reference
Order41 - B2B Buying and Selling. Just Better.
We use GraphQL for serving our API, for inforamtion on about the Query Language itself please check out the official documentation
The API is served under https://api.order41.com for testing end development purposes we do suggest to uese our sandbox environment and its it's playground under https://api.o41.io/graphiql
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
7.26.0
Authentication
Every user of the platform, buyer or seller, can query our api to automate their workflows or integrate with other tools they use.
For testing and development purposes we highly recommend to use our sandbox environment. Short lived Authentication tokens can be retrieved with your accounts details via the login mutation
To receive a test account or long lived API tokens please reach out.
Queries
_getDropMeta
Response
Returns a DropMeta
Example
Query
query _getDropMeta(
$id: ID,
$urlkey: String
) {
_getDropMeta(
id: $id,
urlkey: $urlkey
) {
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
productFilters {
...DropProductFilterFragment
}
}
}
Variables
{
"id": "4",
"urlkey": "abc123"
}
Response
{
"data": {
"_getDropMeta": {
"orderItemsQty": 123.45,
"orderQty": 987,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"productFilters": [DropProductFilter]
}
}
}
_listBrandsMeta
Description
Retrieve meta data for a listBarnds query
Response
Returns a BrandsMeta
Arguments
| Name | Description |
|---|---|
filter - IndustryBrandFilter
|
Filters to be applied on the brands query. Default = {} |
Example
Query
query _listBrandsMeta($filter: IndustryBrandFilter) {
_listBrandsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listBrandsMeta": {"count": 123}}}
_listCartsMeta
Description
Get a list of carts
Response
Returns a CartMeta
Arguments
| Name | Description |
|---|---|
filter - CartFilter
|
Filters to be applied to the notification query |
Example
Query
query _listCartsMeta($filter: CartFilter) {
_listCartsMeta(filter: $filter) {
count
}
}
Variables
{"filter": CartFilter}
Response
{"data": {"_listCartsMeta": {"count": 123}}}
_listConnectRequestsMeta
Description
Get a meta data for a list of connect requests for the current user
Response
Returns a ListConnectRequestsMeta
Arguments
| Name | Description |
|---|---|
filter - ConnectRequestModelFilter
|
Filters to be applied on the connect requests query. Default = {} |
Example
Query
query _listConnectRequestsMeta($filter: ConnectRequestModelFilter) {
_listConnectRequestsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listConnectRequestsMeta": {"count": 123}}}
_listContactsMeta
Description
Retrieve metadata for a list of contacts
Response
Returns a ContactsMeta
Arguments
| Name | Description |
|---|---|
filter - ContactFilter
|
Conditions for filter contact results |
Example
Query
query _listContactsMeta($filter: ContactFilter) {
_listContactsMeta(filter: $filter) {
accessCount
count
}
}
Variables
{"filter": ContactFilter}
Response
{"data": {"_listContactsMeta": {"accessCount": 987, "count": 987}}}
_listDiscountsMeta
Description
Meta data for a list of discounts
Response
Returns a DiscountsMeta
Arguments
| Name | Description |
|---|---|
filter - DiscountFilter
|
Filters to be applied to the discounts query. Default = {} |
Example
Query
query _listDiscountsMeta($filter: DiscountFilter) {
_listDiscountsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listDiscountsMeta": {"count": 123}}}
_listDropsMeta
Description
Retrieve meta data for a listDrops query
Response
Returns a DropsMeta
Arguments
| Name | Description |
|---|---|
filter - DropFilter
|
Filters to be applied on the drops query. Default = {} |
Example
Query
query _listDropsMeta($filter: DropFilter) {
_listDropsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listDropsMeta": {"count": 987}}}
_listEventsMeta
Description
Meta information for the events list.
Response
Returns an EventsMeta
Arguments
| Name | Description |
|---|---|
filters - EventFilter
|
Filters to be applied on the events query. Default = {} |
Example
Query
query _listEventsMeta($filters: EventFilter) {
_listEventsMeta(filters: $filters) {
count
}
}
Variables
{"filters": {}}
Response
{"data": {"_listEventsMeta": {"count": 123}}}
_listIndustriesMeta
Description
Retrieve meta data for a listIndustries query
Response
Returns an IndustriesMeta
Arguments
| Name | Description |
|---|---|
filter - IndustryFilter
|
Filters to be applied on the industries query. Default = {} |
Example
Query
query _listIndustriesMeta($filter: IndustryFilter) {
_listIndustriesMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listIndustriesMeta": {"count": 987}}}
_listNotificationsMeta
Description
Get metadata for a list of notifications
Response
Returns a ListNotificationsMeta
Arguments
| Name | Description |
|---|---|
filter - NotificationFilter
|
Filters to be applied to the notification query. Default = {} |
Example
Query
query _listNotificationsMeta($filter: NotificationFilter) {
_listNotificationsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listNotificationsMeta": {"count": 123}}}
_listOrdersMeta
Response
Returns an OrdersMeta
Arguments
| Name | Description |
|---|---|
filter - OrderFilter
|
filtering options for orders. Default = {} |
Example
Query
query _listOrdersMeta($filter: OrderFilter) {
_listOrdersMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listOrdersMeta": {"count": 987}}}
_listPlansMeta
Description
Retrieve meta data for a listPlans query
Response
Returns a PlansMeta
Arguments
| Name | Description |
|---|---|
filter - PlanFilter
|
Filters to be applied on the query reesults. Default = {} |
Example
Query
query _listPlansMeta($filter: PlanFilter) {
_listPlansMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listPlansMeta": {"count": 123}}}
_listPricelistsMeta
Description
Meta data for a list of pricelists
Response
Returns a PricelistsMeta
Arguments
| Name | Description |
|---|---|
filter - PricelistFilter
|
Filters to be applied to the pricelists query. Default = {} |
Example
Query
query _listPricelistsMeta($filter: PricelistFilter) {
_listPricelistsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listPricelistsMeta": {"count": 987}}}
_listProductsMeta
Description
Retrieve meta data for a list of products
Response
Returns a ProductsMeta
Arguments
| Name | Description |
|---|---|
filter - ProductFilter
|
Filters for the product list. Default = {} |
Example
Query
query _listProductsMeta($filter: ProductFilter) {
_listProductsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"_listProductsMeta": {"count": 123}}}
_listTeamUsersMeta
Response
Returns a TeamUsersMeta
Example
Query
query _listTeamUsersMeta {
_listTeamUsersMeta {
count
}
}
Response
{"data": {"_listTeamUsersMeta": {"count": 123}}}
discoverDrops
Description
Get a list of discoverable drops
Response
Returns [DropWithLink]
Arguments
| Name | Description |
|---|---|
filter - DropFilter
|
Filters to be applied on the discover_drops query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
Example
Query
query DiscoverDrops(
$filter: DropFilter,
$first: Int,
$offset: Int
) {
discoverDrops(
filter: $filter,
first: $first,
offset: $offset
) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropLink
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{"filter": {}, "first": 25, "offset": 0}
Response
{
"data": {
"discoverDrops": [
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 987,
"archive": true,
"asset": "xyz789",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "abc123",
"currencyBuy": "xyz789",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropLink": "abc123",
"dropProducts": [DropProduct],
"filter": 123,
"filters": [123],
"id": "4",
"images": ["abc123"],
"img": "xyz789",
"info": "abc123",
"isPublic": true,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "xyz789",
"openrate": 987,
"order": 123,
"orderItemsQty": 123.45,
"orderQty": 123,
"orderTotal": 123.45,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "xyz789",
"public": false,
"publicVisitorCount": 123,
"rangeDropInt": "xyz789",
"rangeDropText": "abc123",
"season": "xyz789",
"status": 987,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
]
}
}
discoverDropsMeta
Description
Discoverable drops meta
Response
Returns a DropsMeta
Arguments
| Name | Description |
|---|---|
filter - DropFilter
|
Filters to be applied on the discover_drops_meta query. Default = {} |
Example
Query
query DiscoverDropsMeta($filter: DropFilter) {
discoverDropsMeta(filter: $filter) {
count
}
}
Variables
{"filter": {}}
Response
{"data": {"discoverDropsMeta": {"count": 123}}}
drops
Use listDrops instead
Description
Get a list of drops
Response
Returns [Drop]
Example
Query
query Drops(
$first: Int,
$offset: Int
) {
drops(
first: $first,
offset: $offset
) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{"first": 25, "offset": 0}
Response
{
"data": {
"drops": [
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 987,
"archive": true,
"asset": "abc123",
"assets": ["xyz789"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "abc123",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [987],
"id": 4,
"images": ["abc123"],
"img": "xyz789",
"info": "xyz789",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "xyz789",
"openrate": 123,
"order": 987,
"orderItemsQty": 987.65,
"orderQty": 987,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "xyz789",
"products": [Product],
"public": false,
"publicVisitorCount": 123,
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"season": "abc123",
"status": 987,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
]
}
}
exploreDrops
Description
Get a list of suggested drops
Response
Returns [Drop]
Example
Query
query ExploreDrops(
$first: Int,
$offset: Int
) {
exploreDrops(
first: $first,
offset: $offset
) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{"first": 3, "offset": 0}
Response
{
"data": {
"exploreDrops": [
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 987,
"archive": false,
"asset": "abc123",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "xyz789",
"currencySell": "abc123",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "xyz789",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [987],
"id": "4",
"images": ["xyz789"],
"img": "abc123",
"info": "abc123",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "abc123",
"openrate": 987,
"order": 123,
"orderItemsQty": 123.45,
"orderQty": 987,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "xyz789",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "xyz789",
"products": [Product],
"public": true,
"publicVisitorCount": 123,
"rangeDropInt": "abc123",
"rangeDropText": "abc123",
"season": "abc123",
"status": 987,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
]
}
}
getBackgroundJob
Description
Reject a connect request
Response
Returns a BackgroundJob
Arguments
| Name | Description |
|---|---|
id - ID!
|
bg job id |
Example
Query
query GetBackgroundJob($id: ID!) {
getBackgroundJob(id: $id) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getBackgroundJob": {
"completedAt": "2007-12-03T10:15:30Z",
"contactId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"dropId": 4,
"id": "4",
"orderId": "4",
"result": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
getCart
Description
Get single Cart by ID or urlkey
Response
Returns a Cart
Example
Query
query GetCart(
$id: ID,
$urlkey: String
) {
getCart(
id: $id,
urlkey: $urlkey
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"getCart": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": 4,
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "abc123",
"drop": Drop,
"dropId": 4,
"guestId": 4,
"id": "4",
"isPrivate": false,
"ownerId": 4,
"parentProducts": [CartProduct],
"repId": "4",
"seller": User,
"sellerId": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
}
}
getConnectRequest
Description
Retrieve single connect request by id
Response
Returns a ConnectRequest
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
query GetConnectRequest($id: ID) {
getConnectRequest(id: $id) {
acceptedAt
createdAt
id
rejectedAt
requesterUser {
...UserFragment
}
source
targetUser {
...UserFragment
}
term
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getConnectRequest": {
"acceptedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"rejectedAt": "2007-12-03T10:15:30Z",
"requesterUser": User,
"source": "xyz789",
"targetUser": User,
"term": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
getContact
Description
Get a single Contact
Response
Returns a Contact
Example
Query
query GetContact(
$id: ID,
$urlkey: String
) {
getContact(
id: $id,
urlkey: $urlkey
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
"data": {
"getContact": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "xyz789",
"customId": "xyz789",
"defaultSupplier": 123,
"discount": 123.45,
"email": "abc123",
"id": 4,
"img": ["abc123"],
"invite": true,
"invoiceAddress": "xyz789",
"invoiceApartment": "abc123",
"invoiceCity": "abc123",
"invoiceCompany": "abc123",
"invoiceCountry": "xyz789",
"invoiceFirstname": "abc123",
"invoiceLastname": "xyz789",
"invoicePostalcode": "xyz789",
"invoiceRegion": "abc123",
"isSuperman": true,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "abc123",
"name": "xyz789",
"notes": "abc123",
"ownerId": 4,
"paymentBankCustom": "xyz789",
"paymentEmail": "abc123",
"paymentIbanCustom": "xyz789",
"paymentMethod": "xyz789",
"paymentTaxCode": "abc123",
"paymentVatCustom": "abc123",
"phone": "abc123",
"shippingAddress": "abc123",
"shippingApartment": "abc123",
"shippingCity": "xyz789",
"shippingCompany": "xyz789",
"shippingCountry": "xyz789",
"shippingFirstname": "abc123",
"shippingLastname": "xyz789",
"shippingPostalcode": "xyz789",
"shippingRegion": "xyz789",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 987,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "xyz789"
}
}
}
getCredential
Description
Get credential for the user.
Response
Returns a Credential
Example
Query
query GetCredential {
getCredential {
accountType
email
isAdmin
nlAccept
plan {
...PlanFragment
}
recovery
recoveryInform
representing {
...UserFragment
}
status
userId
welcome
}
}
Response
{
"data": {
"getCredential": {
"accountType": "BUYER",
"email": "xyz789",
"isAdmin": false,
"nlAccept": false,
"plan": Plan,
"recovery": "abc123",
"recoveryInform": false,
"representing": [User],
"status": true,
"userId": "4",
"welcome": false
}
}
}
getDiscount
Description
get discount by id
Response
Returns a Discount
Example
Query
query GetDiscount(
$id: ID,
$urlkey: ID
) {
getDiscount(
id: $id,
urlkey: $urlkey
) {
active
applications
fixedAmountValue
id
name
ownerId
percentageValue
quantityOrAmount
status
type
urlkey
xgetyItems
xgetyMinimumAmount
xgetyMinimumQtyItems
xgetyPercentage
}
}
Variables
{"id": 4, "urlkey": "4"}
Response
{
"data": {
"getDiscount": {
"active": true,
"applications": 987,
"fixedAmountValue": 123.45,
"id": "4",
"name": "abc123",
"ownerId": 4,
"percentageValue": 987.65,
"quantityOrAmount": 123,
"status": true,
"type": 987,
"urlkey": "4",
"xgetyItems": "abc123",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 123.45,
"xgetyPercentage": 123.45
}
}
}
getDiscounts
Use listDiscounts insptead
Description
get discounts
Response
Returns [Discount]
Example
Query
query GetDiscounts(
$first: Int,
$offset: Int,
$query: String
) {
getDiscounts(
first: $first,
offset: $offset,
query: $query
) {
active
applications
fixedAmountValue
id
name
ownerId
percentageValue
quantityOrAmount
status
type
urlkey
xgetyItems
xgetyMinimumAmount
xgetyMinimumQtyItems
xgetyPercentage
}
}
Variables
{"first": 25, "offset": 0, "query": ""}
Response
{
"data": {
"getDiscounts": [
{
"active": false,
"applications": 987,
"fixedAmountValue": 987.65,
"id": "4",
"name": "xyz789",
"ownerId": "4",
"percentageValue": 987.65,
"quantityOrAmount": 123,
"status": false,
"type": 123,
"urlkey": "4",
"xgetyItems": "abc123",
"xgetyMinimumAmount": 123.45,
"xgetyMinimumQtyItems": 987.65,
"xgetyPercentage": 987.65
}
]
}
}
getDrop
Description
Get single Drop by ID
Response
Returns a Drop
Example
Query
query GetDrop(
$id: ID,
$urlkey: String
) {
getDrop(
id: $id,
urlkey: $urlkey
) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"getDrop": {
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 123,
"archive": true,
"asset": "abc123",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "abc123",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": true,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [987],
"id": "4",
"images": ["xyz789"],
"img": "abc123",
"info": "xyz789",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "xyz789",
"note": "abc123",
"openrate": 987,
"order": 987,
"orderItemsQty": 987.65,
"orderQty": 987,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "xyz789",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "abc123",
"products": [Product],
"public": false,
"publicVisitorCount": 987,
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"season": "xyz789",
"status": 987,
"supplier": Contact,
"supplierName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
}
}
getDropProfile
Description
Retrieve user profile by a drop ID or urlkey
Response
Returns a User
Example
Query
query GetDropProfile(
$id: ID,
$urlkey: String
) {
getDropProfile(
id: $id,
urlkey: $urlkey
) {
canSearch
contacts {
...ContactFragment
}
discoverable
displayName
emailProfile
facebook
id
image
imageMood
images
img
imgMood
info
instagram
name
phone
plans {
...UserPlanFragment
}
setting {
...SettingFragment
}
twitter
url
urlName
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"getDropProfile": {
"canSearch": true,
"contacts": [Contact],
"discoverable": false,
"displayName": "abc123",
"emailProfile": "abc123",
"facebook": "abc123",
"id": 4,
"image": "xyz789",
"imageMood": "abc123",
"images": ["xyz789"],
"img": ["xyz789"],
"imgMood": ["abc123"],
"info": "abc123",
"instagram": "xyz789",
"name": "abc123",
"phone": "abc123",
"plans": [UserPlan],
"setting": Setting,
"twitter": "xyz789",
"url": "xyz789",
"urlName": "abc123",
"urlkey": "xyz789"
}
}
}
getDropRate
getEvent
Description
Get an event by id
getExternalContacts
use listExternalContacts instead
Description
get external contacts
Response
Returns [ExternalContact]
Arguments
| Name | Description |
|---|---|
contactIds - [ID]
|
contact ids |
Example
Query
query GetExternalContacts($contactIds: [ID]) {
getExternalContacts(contactIds: $contactIds) {
contactId
externalSystemId
externalSystemName
extra
partnerIntegrationId
}
}
Variables
{"contactIds": [4]}
Response
{
"data": {
"getExternalContacts": [
{
"contactId": "4",
"externalSystemId": 4,
"externalSystemName": "xyz789",
"extra": "xyz789",
"partnerIntegrationId": 4
}
]
}
}
getExternalOrders
use listExternalOrders instead
Description
get external order ids
Response
Returns [ExternalOrder]
Arguments
| Name | Description |
|---|---|
orderIds - [ID]
|
order ids |
Example
Query
query GetExternalOrders($orderIds: [ID]) {
getExternalOrders(orderIds: $orderIds) {
externalSystemId
externalSystemName
extra
orderId
partnerIntegrationId
}
}
Variables
{"orderIds": [4]}
Response
{
"data": {
"getExternalOrders": [
{
"externalSystemId": "4",
"externalSystemName": "abc123",
"extra": "xyz789",
"orderId": "4",
"partnerIntegrationId": 4
}
]
}
}
getExternalProducts
use listExternalProducts instead
Description
get external product ids
Response
Returns [ExternalProduct]
Arguments
| Name | Description |
|---|---|
productIds - [ID]
|
product ids |
Example
Query
query GetExternalProducts($productIds: [ID]) {
getExternalProducts(productIds: $productIds) {
externalSystemId
externalSystemName
extra
partnerIntegrationId
productId
}
}
Variables
{"productIds": ["4"]}
Response
{
"data": {
"getExternalProducts": [
{
"externalSystemId": "4",
"externalSystemName": "abc123",
"extra": "abc123",
"partnerIntegrationId": 4,
"productId": 4
}
]
}
}
getIntegration
Description
get integration
Response
Returns an Integration
Arguments
| Name | Description |
|---|---|
userId - ID
|
if nouser token is used this is required |
Example
Query
query GetIntegration($userId: ID) {
getIntegration(userId: $userId) {
id
ownerId
shopifyAdminApiAccessToken
shopifyApiSecretKey
shopifyUrl
}
}
Variables
{"userId": "4"}
Response
{
"data": {
"getIntegration": {
"id": "4",
"ownerId": 4,
"shopifyAdminApiAccessToken": "xyz789",
"shopifyApiSecretKey": "abc123",
"shopifyUrl": "xyz789"
}
}
}
getIntegrationData
Description
get integration data
Response
Returns [IntegrationData]
Example
Query
query GetIntegrationData(
$fieldNames: [String],
$userId: ID
) {
getIntegrationData(
fieldNames: $fieldNames,
userId: $userId
) {
fieldName
value
}
}
Variables
{
"fieldNames": ["xyz789"],
"userId": "4"
}
Response
{
"data": {
"getIntegrationData": [
{
"fieldName": "abc123",
"value": "abc123"
}
]
}
}
getIntegrationTokenByOrderId
Description
get integration by order id
Response
Returns an IntegrationData
Arguments
| Name | Description |
|---|---|
orderId - ID
|
Example
Query
query GetIntegrationTokenByOrderId($orderId: ID) {
getIntegrationTokenByOrderId(orderId: $orderId) {
fieldName
value
}
}
Variables
{"orderId": 4}
Response
{
"data": {
"getIntegrationTokenByOrderId": {
"fieldName": "abc123",
"value": "xyz789"
}
}
}
getOrder
Description
Get an order by id or urlkey.
Response
Returns an Order
Example
Query
query GetOrder(
$id: ID,
$urlkey: String
) {
getOrder(
id: $id,
urlkey: $urlkey
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"getOrder": {
"appliedDiscountId": 4,
"appliedPricelistId": 4,
"buyer": User,
"buyerId": "4",
"buyerName": "abc123",
"cancel": false,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "abc123",
"customId": "abc123",
"discountAmount": 987.65,
"discountType": "xyz789",
"drop": Drop,
"dropId": 4,
"extraCosts": 123.45,
"id": 4,
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "abc123",
"owner": User,
"ownerId": 4,
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "xyz789",
"rangeOrderText": "abc123",
"rating": 987,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": 4,
"shippingCosts": 123.45,
"status": true,
"sumOfProducts": 987.65,
"supplierName": "xyz789",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 123.45
}
}
}
getOrdersPricelistId
Description
Get order's (valid) pricelist_id
Response
Returns an OrderPricelist
Arguments
| Name | Description |
|---|---|
orderId - ID
|
order id |
Example
Query
query GetOrdersPricelistId($orderId: ID) {
getOrdersPricelistId(orderId: $orderId) {
pricelistId
valid
}
}
Variables
{"orderId": "4"}
Response
{
"data": {
"getOrdersPricelistId": {
"pricelistId": "4",
"valid": false
}
}
}
getPartnerIntegration
Description
query for getting a partner integration
Response
Returns a PartnerIntegration
Arguments
| Name | Description |
|---|---|
id - ID
|
id of the partner integration |
Example
Query
query GetPartnerIntegration($id: ID) {
getPartnerIntegration(id: $id) {
id
listConfigurations {
...IntegrationConfigurationFragment
}
name
owner {
...UserFragment
}
ownerId
type
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getPartnerIntegration": {
"id": 4,
"listConfigurations": [IntegrationConfiguration],
"name": "abc123",
"owner": User,
"ownerId": "4",
"type": "xyz789"
}
}
}
getPaymentSubscription
Description
Get paymentSubscription.
Response
Returns a PaymentSubscription
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
query GetPaymentSubscription($id: ID) {
getPaymentSubscription(id: $id) {
id
stripeCustomerId
stripeProductId
stripeSubscriptionId
stripeSubscriptionStatus
}
}
Variables
{"id": 4}
Response
{
"data": {
"getPaymentSubscription": {
"id": "4",
"stripeCustomerId": "abc123",
"stripeProductId": "abc123",
"stripeSubscriptionId": "xyz789",
"stripeSubscriptionStatus": "xyz789"
}
}
}
getPlan
Description
get plan by id
Example
Query
query GetPlan($id: ID!) {
getPlan(id: $id) {
accountType
description
id
name
}
}
Variables
{"id": 4}
Response
{
"data": {
"getPlan": {
"accountType": "abc123",
"description": "xyz789",
"id": 4,
"name": "xyz789"
}
}
}
getPricelist
Description
Retrieve single pricelist by id
Example
Query
query GetPricelist($id: ID) {
getPricelist(id: $id) {
_access {
..._PricelistAccessMetaFragment
}
_values {
..._PricelistValueMetaFragment
}
access {
...PricelistAccessFragment
}
currency
drop {
...DropFragment
}
dropId
dropName
id
name
owner {
...UserFragment
}
ownerId
status
type
urlkey
values {
...PricelistValueFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getPricelist": {
"_access": _PricelistAccessMeta,
"_values": _PricelistValueMeta,
"access": [PricelistAccess],
"currency": "xyz789",
"drop": Drop,
"dropId": "4",
"dropName": "abc123",
"id": 4,
"name": "abc123",
"owner": User,
"ownerId": 4,
"status": false,
"type": 987,
"urlkey": "xyz789",
"values": [PricelistValue]
}
}
}
getPricelistValuesByPricelistId
Description
Get pricelist values by id
Response
Returns [PricelistValue]
Arguments
| Name | Description |
|---|---|
pricelistId - ID!
|
Example
Query
query GetPricelistValuesByPricelistId($pricelistId: ID!) {
getPricelistValuesByPricelistId(pricelistId: $pricelistId) {
drop {
...DropFragment
}
dropId
id
ownerId
price
priceList
pricelistId
product {
...ProductFragment
}
productId
rrp
rrpList
}
}
Variables
{"pricelistId": 4}
Response
{
"data": {
"getPricelistValuesByPricelistId": [
{
"drop": Drop,
"dropId": "4",
"id": "4",
"ownerId": 4,
"price": 123.45,
"priceList": 123.45,
"pricelistId": "4",
"product": Product,
"productId": 4,
"rrp": "xyz789",
"rrpList": "abc123"
}
]
}
}
getPricelists
listPricelists instead
Description
get pricelists
Response
Returns [Pricelist]
Example
Query
query GetPricelists(
$first: Int,
$offset: Int,
$query: String
) {
getPricelists(
first: $first,
offset: $offset,
query: $query
) {
_access {
..._PricelistAccessMetaFragment
}
_values {
..._PricelistValueMetaFragment
}
access {
...PricelistAccessFragment
}
currency
drop {
...DropFragment
}
dropId
dropName
id
name
owner {
...UserFragment
}
ownerId
status
type
urlkey
values {
...PricelistValueFragment
}
}
}
Variables
{"first": 25, "offset": 0, "query": ""}
Response
{
"data": {
"getPricelists": [
{
"_access": _PricelistAccessMeta,
"_values": _PricelistValueMeta,
"access": [PricelistAccess],
"currency": "abc123",
"drop": Drop,
"dropId": 4,
"dropName": "xyz789",
"id": 4,
"name": "abc123",
"owner": User,
"ownerId": "4",
"status": false,
"type": 987,
"urlkey": "abc123",
"values": [PricelistValue]
}
]
}
}
getProduct
Description
Get a single product
Response
Returns a Product
Example
Query
query GetProduct(
$id: ID,
$urlkey: String
) {
getProduct(
id: $id,
urlkey: $urlkey
) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
"data": {
"getProduct": {
"color": "abc123",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "abc123",
"customField3": "xyz789",
"customField4": "abc123",
"customField5": "xyz789",
"customField6": "abc123",
"customField7": "abc123",
"customField8": "abc123",
"customId": "abc123",
"customIdInt": "xyz789",
"customIdText": "abc123",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": "4",
"images": ["abc123"],
"img": "xyz789",
"info": "abc123",
"inventoryStock": "abc123",
"inventoryStockLimit": "xyz789",
"material": "abc123",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "xyz789",
"optionValue2": "abc123",
"optionValue3": "abc123",
"optionValue4": "abc123",
"optionValue5": "xyz789",
"origin": "xyz789",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "abc123",
"price": 123.45,
"rangeProductInt": "xyz789",
"rangeProductText": "xyz789",
"rrp": "abc123",
"sku": "xyz789",
"soldOut": false,
"supplier": Contact,
"supplierId": 4,
"supplierName": "xyz789",
"taric": "xyz789",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
}
}
getProductsByIds
Use listProducts instead
Description
Get a list of products by ids
Example
Query
query GetProductsByIds($productIds: [ID]) {
getProductsByIds(productIds: $productIds) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"productIds": [4]}
Response
{
"data": {
"getProductsByIds": [
{
"color": "abc123",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "xyz789",
"customField2": "abc123",
"customField3": "xyz789",
"customField4": "xyz789",
"customField5": "abc123",
"customField6": "abc123",
"customField7": "xyz789",
"customField8": "abc123",
"customId": "xyz789",
"customIdInt": "xyz789",
"customIdText": "xyz789",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["xyz789"],
"img": "abc123",
"info": "abc123",
"inventoryStock": "xyz789",
"inventoryStockLimit": "abc123",
"material": "xyz789",
"name": "abc123",
"optionGroups": [ProductOptionGroup],
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "abc123",
"optionValue5": "xyz789",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "abc123",
"price": 987.65,
"rangeProductInt": "abc123",
"rangeProductText": "abc123",
"rrp": "xyz789",
"sku": "xyz789",
"soldOut": true,
"supplier": Contact,
"supplierId": "4",
"supplierName": "xyz789",
"taric": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"variants": [Product],
"variantsV2": [ProductVariant]
}
]
}
}
getProfile
Description
Get account info for the dashboard
Response
Returns a User
Example
Query
query GetProfile(
$id: ID,
$urlkey: String
) {
getProfile(
id: $id,
urlkey: $urlkey
) {
canSearch
contacts {
...ContactFragment
}
discoverable
displayName
emailProfile
facebook
id
image
imageMood
images
img
imgMood
info
instagram
name
phone
plans {
...UserPlanFragment
}
setting {
...SettingFragment
}
twitter
url
urlName
urlkey
}
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
"data": {
"getProfile": {
"canSearch": true,
"contacts": [Contact],
"discoverable": true,
"displayName": "xyz789",
"emailProfile": "xyz789",
"facebook": "xyz789",
"id": 4,
"image": "abc123",
"imageMood": "xyz789",
"images": ["xyz789"],
"img": ["xyz789"],
"imgMood": ["xyz789"],
"info": "abc123",
"instagram": "abc123",
"name": "abc123",
"phone": "xyz789",
"plans": [UserPlan],
"setting": Setting,
"twitter": "xyz789",
"url": "abc123",
"urlName": "abc123",
"urlkey": "abc123"
}
}
}
getProfiles
To be removed without replacement
Description
Get user profiles
Response
Returns [User]
Example
Query
query GetProfiles {
getProfiles {
canSearch
contacts {
...ContactFragment
}
discoverable
displayName
emailProfile
facebook
id
image
imageMood
images
img
imgMood
info
instagram
name
phone
plans {
...UserPlanFragment
}
setting {
...SettingFragment
}
twitter
url
urlName
urlkey
}
}
Response
{
"data": {
"getProfiles": [
{
"canSearch": false,
"contacts": [Contact],
"discoverable": true,
"displayName": "abc123",
"emailProfile": "xyz789",
"facebook": "abc123",
"id": "4",
"image": "abc123",
"imageMood": "abc123",
"images": ["abc123"],
"img": ["abc123"],
"imgMood": ["abc123"],
"info": "xyz789",
"instagram": "xyz789",
"name": "abc123",
"phone": "abc123",
"plans": [UserPlan],
"setting": Setting,
"twitter": "xyz789",
"url": "xyz789",
"urlName": "abc123",
"urlkey": "abc123"
}
]
}
}
getSetting
Description
Get user settings
Response
Returns a Setting
Example
Query
query GetSetting {
getSetting {
addressAddress
addressApartment
addressCity
addressCompany
addressCountry
addressFirstname
addressLastname
addressPostalcode
country {
...CountryFragment
}
customAttach
customField1Name
customField1Status
customField2Name
customField2Status
customField3Name
customField3Status
customField4Name
customField4Status
customField5Name
customField5Status
customField6Name
customField6Status
customField7Name
customField7Status
customField8Name
customField8Status
customHeight
customInventory
customInvite
customInviteSubject
customOption1Name
customOption1Status
customOption2Name
customOption2Status
customOption3Name
customOption3Status
customOption4Name
customOption4Status
customOption5Name
customOption5Status
customPreorder
customSeperator
customThankyou
customUpdate
customWidth
fromCsv
fromEmail
fromMessage
fromPdf
fromSubject
industries
integrationToken {
...TokenFragment
}
integrationTokenId
invoiceText
ownerId
paymentBank
paymentIban
paymentVat
rangeDropInt
rangeDropText
rangeOrderInt
rangeOrderText
rangeProductInt
rangeProductText
rangeSupplierInt
rangeSupplierText
showInDashboard
}
}
Response
{
"data": {
"getSetting": {
"addressAddress": "abc123",
"addressApartment": "xyz789",
"addressCity": "abc123",
"addressCompany": "abc123",
"addressCountry": "xyz789",
"addressFirstname": "xyz789",
"addressLastname": "xyz789",
"addressPostalcode": "xyz789",
"country": Country,
"customAttach": 123,
"customField1Name": "abc123",
"customField1Status": 987,
"customField2Name": "xyz789",
"customField2Status": 987,
"customField3Name": "abc123",
"customField3Status": 123,
"customField4Name": "abc123",
"customField4Status": 987,
"customField5Name": "abc123",
"customField5Status": 123,
"customField6Name": "xyz789",
"customField6Status": 987,
"customField7Name": "xyz789",
"customField7Status": 987,
"customField8Name": "xyz789",
"customField8Status": 987,
"customHeight": "abc123",
"customInventory": 987,
"customInvite": "abc123",
"customInviteSubject": "xyz789",
"customOption1Name": "abc123",
"customOption1Status": 123,
"customOption2Name": "abc123",
"customOption2Status": 987,
"customOption3Name": "xyz789",
"customOption3Status": 987,
"customOption4Name": "xyz789",
"customOption4Status": 987,
"customOption5Name": "abc123",
"customOption5Status": 123,
"customPreorder": 123,
"customSeperator": 987,
"customThankyou": "xyz789",
"customUpdate": "xyz789",
"customWidth": "xyz789",
"fromCsv": false,
"fromEmail": "abc123",
"fromMessage": "abc123",
"fromPdf": true,
"fromSubject": "abc123",
"industries": ["abc123"],
"integrationToken": Token,
"integrationTokenId": "4",
"invoiceText": "xyz789",
"ownerId": "4",
"paymentBank": "xyz789",
"paymentIban": "xyz789",
"paymentVat": "xyz789",
"rangeDropInt": "xyz789",
"rangeDropText": "abc123",
"rangeOrderInt": "abc123",
"rangeOrderText": "abc123",
"rangeProductInt": "abc123",
"rangeProductText": "xyz789",
"rangeSupplierInt": "abc123",
"rangeSupplierText": "abc123",
"showInDashboard": true
}
}
}
listBrands
Description
list brands (filter by industry_id or brand_id)
Response
Returns [Brand]
Arguments
| Name | Description |
|---|---|
filter - IndustryBrandFilter
|
Filters to be applied on the industry_brand query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [BrandModelOrder]
|
Options for sorting the results. Default = [CREATED_AT_DESC] |
Example
Query
query ListBrands(
$filter: IndustryBrandFilter,
$first: Int,
$offset: Int,
$orderBy: [BrandModelOrder]
) {
listBrands(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
id
name
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["CREATED_AT_DESC"]}
Response
{
"data": {
"listBrands": [
{"id": 4, "name": "xyz789"}
]
}
}
listCarts
Description
Get a list of carts
Response
Returns [Cart]
Arguments
| Name | Description |
|---|---|
filter - CartFilter
|
Filters to be applied to the carts query. Default = {} |
first - Int
|
Number of elements to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [CartModelOrder]
|
Options for sorting the results. Default = [UPDATED_AT_DESC] |
Example
Query
query ListCarts(
$filter: CartFilter,
$first: Int,
$offset: Int,
$orderBy: [CartModelOrder]
) {
listCarts(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
"data": {
"listCarts": [
{
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": "4",
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "xyz789",
"drop": Drop,
"dropId": 4,
"guestId": 4,
"id": "4",
"isPrivate": true,
"ownerId": "4",
"parentProducts": [CartProduct],
"repId": 4,
"seller": User,
"sellerId": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
]
}
}
listConnectRequests
Description
Get a list of connect requests for current user
Response
Returns [ConnectRequest]
Arguments
| Name | Description |
|---|---|
filter - ConnectRequestModelFilter
|
Filters to be applied on the connect requests query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [ConnectRequestModelOrder]
|
Options for sorting the results. Default = [ID_DESC] |
Example
Query
query ListConnectRequests(
$filter: ConnectRequestModelFilter,
$first: Int,
$offset: Int,
$orderBy: [ConnectRequestModelOrder]
) {
listConnectRequests(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
acceptedAt
createdAt
id
rejectedAt
requesterUser {
...UserFragment
}
source
targetUser {
...UserFragment
}
term
updatedAt
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_DESC"]}
Response
{
"data": {
"listConnectRequests": [
{
"acceptedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"rejectedAt": "2007-12-03T10:15:30Z",
"requesterUser": User,
"source": "xyz789",
"targetUser": User,
"term": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
listContacts
Description
Get a list of contacts
Response
Returns [Contact]
Arguments
| Name | Description |
|---|---|
filter - ContactFilter
|
Conditions for filter contact results |
first - Int
|
Number of elements to retrieve, defaults to 100. Default = 100 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [ContactModelOrder]
|
Options for sorting the results. Default = [ID_DESC] |
Example
Query
query ListContacts(
$filter: ContactFilter,
$first: Int,
$offset: Int,
$orderBy: [ContactModelOrder]
) {
listContacts(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{
"filter": ContactFilter,
"first": 100,
"offset": 0,
"orderBy": ["ID_DESC"]
}
Response
{
"data": {
"listContacts": [
{
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": "4",
"currency": "xyz789",
"customId": "xyz789",
"defaultSupplier": 123,
"discount": 123.45,
"email": "xyz789",
"id": "4",
"img": ["abc123"],
"invite": true,
"invoiceAddress": "abc123",
"invoiceApartment": "abc123",
"invoiceCity": "xyz789",
"invoiceCompany": "abc123",
"invoiceCountry": "xyz789",
"invoiceFirstname": "abc123",
"invoiceLastname": "xyz789",
"invoicePostalcode": "abc123",
"invoiceRegion": "xyz789",
"isSuperman": false,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "abc123",
"name": "abc123",
"notes": "abc123",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "abc123",
"paymentMethod": "xyz789",
"paymentTaxCode": "abc123",
"paymentVatCustom": "xyz789",
"phone": "abc123",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "xyz789",
"shippingCompany": "xyz789",
"shippingCountry": "xyz789",
"shippingFirstname": "abc123",
"shippingLastname": "abc123",
"shippingPostalcode": "xyz789",
"shippingRegion": "xyz789",
"showConnectButton": true,
"showPaymentTaxCode": true,
"status": 987,
"termOfPayment": "xyz789",
"type": 987,
"urlkey": "xyz789"
}
]
}
}
listContactsV2
Use listContacts instead - unctionality is identic
Description
Get a list of contacts
Response
Returns [Contact]
Arguments
| Name | Description |
|---|---|
filter - ContactFilter
|
Conditions for filter contact results |
first - Int
|
Number of elements to retrieve, defaults to 100. Default = 100 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [ContactModelOrder]
|
Options for sorting the results. Default = [ID_DESC] |
Example
Query
query ListContactsV2(
$filter: ContactFilter,
$first: Int,
$offset: Int,
$orderBy: [ContactModelOrder]
) {
listContactsV2(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{
"filter": ContactFilter,
"first": 100,
"offset": 0,
"orderBy": ["ID_DESC"]
}
Response
{
"data": {
"listContactsV2": [
{
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": "4",
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 987,
"discount": 987.65,
"email": "abc123",
"id": "4",
"img": ["xyz789"],
"invite": false,
"invoiceAddress": "xyz789",
"invoiceApartment": "xyz789",
"invoiceCity": "xyz789",
"invoiceCompany": "abc123",
"invoiceCountry": "abc123",
"invoiceFirstname": "xyz789",
"invoiceLastname": "abc123",
"invoicePostalcode": "xyz789",
"invoiceRegion": "abc123",
"isSuperman": false,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "xyz789",
"name": "abc123",
"notes": "xyz789",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "xyz789",
"paymentMethod": "abc123",
"paymentTaxCode": "xyz789",
"paymentVatCustom": "abc123",
"phone": "xyz789",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "xyz789",
"shippingCompany": "xyz789",
"shippingCountry": "abc123",
"shippingFirstname": "abc123",
"shippingLastname": "xyz789",
"shippingPostalcode": "abc123",
"shippingRegion": "abc123",
"showConnectButton": true,
"showPaymentTaxCode": true,
"status": 987,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "abc123"
}
]
}
}
listDiscounts
Description
List discounts with pagination and filtering
Response
Returns [Discount]
Arguments
| Name | Description |
|---|---|
filter - DiscountFilter
|
Filters to be applied to the discounts query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [DiscountModelOrder]
|
Filters to be applied to the discounts query. Default = [ID_DESC] |
Example
Query
query ListDiscounts(
$filter: DiscountFilter,
$first: Int,
$offset: Int,
$orderBy: [DiscountModelOrder]
) {
listDiscounts(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
active
applications
fixedAmountValue
id
name
ownerId
percentageValue
quantityOrAmount
status
type
urlkey
xgetyItems
xgetyMinimumAmount
xgetyMinimumQtyItems
xgetyPercentage
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_DESC"]}
Response
{
"data": {
"listDiscounts": [
{
"active": false,
"applications": 987,
"fixedAmountValue": 123.45,
"id": "4",
"name": "xyz789",
"ownerId": 4,
"percentageValue": 987.65,
"quantityOrAmount": 123,
"status": false,
"type": 123,
"urlkey": 4,
"xgetyItems": "xyz789",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 987.65,
"xgetyPercentage": 987.65
}
]
}
}
listDrops
Description
Retrieve list a paginated list of drops
Response
Returns [Drop]
Arguments
| Name | Description |
|---|---|
filter - DropFilter
|
Filters to be applied on the drops query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [DropModelOrder]
|
Options for sorting the results. Default = [UPDATED_AT_DESC] |
Example
Query
query ListDrops(
$filter: DropFilter,
$first: Int,
$offset: Int,
$orderBy: [DropModelOrder]
) {
listDrops(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
"data": {
"listDrops": [
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 123,
"archive": false,
"asset": "abc123",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "xyz789",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [987],
"id": "4",
"images": ["xyz789"],
"img": "xyz789",
"info": "abc123",
"isPublic": true,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "xyz789",
"openrate": 123,
"order": 987,
"orderItemsQty": 987.65,
"orderQty": 123,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "abc123",
"products": [Product],
"public": false,
"publicVisitorCount": 987,
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"season": "abc123",
"status": 123,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
]
}
}
listEvents
Description
Get a list of events
Response
Returns [Event]
Arguments
| Name | Description |
|---|---|
filters - EventFilter
|
Filters to be applied on the events query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [EventModelOrder]
|
Options for sorting the results. Default = [UPDATED_AT_DESC] |
Example
Query
query ListEvents(
$filters: EventFilter,
$first: Int,
$offset: Int,
$orderBy: [EventModelOrder]
) {
listEvents(
filters: $filters,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
id
payload
type
}
}
Variables
{"filters": {}, "first": 25, "offset": 0, "orderBy": ["UPDATED_AT_DESC"]}
Response
{
"data": {
"listEvents": [
{
"id": "4",
"payload": Json,
"type": "xyz789"
}
]
}
}
listExternalContacts
Response
Returns [ExternalContact]
Arguments
| Name | Description |
|---|---|
filter - ExternalContactFilter
|
filter |
first - Int
|
Number of elements to retrieve, defaults to 10. Default = 100 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
Example
Query
query ListExternalContacts(
$filter: ExternalContactFilter,
$first: Int,
$offset: Int
) {
listExternalContacts(
filter: $filter,
first: $first,
offset: $offset
) {
contactId
externalSystemId
externalSystemName
extra
partnerIntegrationId
}
}
Variables
{
"filter": ExternalContactFilter,
"first": 100,
"offset": 0
}
Response
{
"data": {
"listExternalContacts": [
{
"contactId": "4",
"externalSystemId": 4,
"externalSystemName": "abc123",
"extra": "abc123",
"partnerIntegrationId": "4"
}
]
}
}
listExternalOrders
Response
Returns [ExternalOrder]
Arguments
| Name | Description |
|---|---|
filter - ExternalOrderFilter
|
filter |
first - Int
|
Number of elements to retrieve, defaults to 10. Default = 100 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
Example
Query
query ListExternalOrders(
$filter: ExternalOrderFilter,
$first: Int,
$offset: Int
) {
listExternalOrders(
filter: $filter,
first: $first,
offset: $offset
) {
externalSystemId
externalSystemName
extra
orderId
partnerIntegrationId
}
}
Variables
{"filter": ExternalOrderFilter, "first": 100, "offset": 0}
Response
{
"data": {
"listExternalOrders": [
{
"externalSystemId": 4,
"externalSystemName": "abc123",
"extra": "abc123",
"orderId": "4",
"partnerIntegrationId": 4
}
]
}
}
listExternalProducts
Response
Returns [ExternalProduct]
Arguments
| Name | Description |
|---|---|
filter - ExternalProductFilter
|
filter |
first - Int
|
Number of elements to retrieve, defaults to 10. Default = 100 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
Example
Query
query ListExternalProducts(
$filter: ExternalProductFilter,
$first: Int,
$offset: Int
) {
listExternalProducts(
filter: $filter,
first: $first,
offset: $offset
) {
externalSystemId
externalSystemName
extra
partnerIntegrationId
productId
}
}
Variables
{
"filter": ExternalProductFilter,
"first": 100,
"offset": 0
}
Response
{
"data": {
"listExternalProducts": [
{
"externalSystemId": "4",
"externalSystemName": "xyz789",
"extra": "abc123",
"partnerIntegrationId": 4,
"productId": "4"
}
]
}
}
listIndustries
Description
Retrieve list a paginated list of industries
Response
Returns [Industry]
Arguments
| Name | Description |
|---|---|
filter - IndustryFilter
|
Filters to be applied on the industries query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [IndustryModelOrder]
|
Options for sorting the results. Default = [ID_ASC] |
Example
Query
query ListIndustries(
$filter: IndustryFilter,
$first: Int,
$offset: Int,
$orderBy: [IndustryModelOrder]
) {
listIndustries(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
id
listBrands {
...BrandFragment
}
name
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
"data": {
"listIndustries": [
{
"id": 4,
"listBrands": [Brand],
"name": "abc123"
}
]
}
}
listIntegrationConfigurations
Description
query for listing integration configurations
Response
Returns [IntegrationConfiguration]
Arguments
| Name | Description |
|---|---|
filter - IntegrationConfigurationFilter
|
Filters to be applied on the returned objects. Default = {} |
first - Int
|
Number of elements to retrieve, defaults to 100. Default = 100 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
Example
Query
query ListIntegrationConfigurations(
$filter: IntegrationConfigurationFilter,
$first: Int,
$offset: Int
) {
listIntegrationConfigurations(
filter: $filter,
first: $first,
offset: $offset
) {
id
key
partnerIntegrationId
value
}
}
Variables
{"filter": {}, "first": 100, "offset": 0}
Response
{
"data": {
"listIntegrationConfigurations": [
{
"id": 4,
"key": "xyz789",
"partnerIntegrationId": 4,
"value": "xyz789"
}
]
}
}
listNotifications
Description
Get a list of notifications
Response
Returns [Notification]
Arguments
| Name | Description |
|---|---|
filter - NotificationFilter
|
Filters to be applied to the notification query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
Example
Query
query ListNotifications(
$filter: NotificationFilter,
$first: Int,
$offset: Int
) {
listNotifications(
filter: $filter,
first: $first,
offset: $offset
) {
createdAt
id
object {
... on ConnectRequest {
...ConnectRequestFragment
}
}
payload
seenAt
type
updatedAt
}
}
Variables
{"filter": {}, "first": 25, "offset": 0}
Response
{
"data": {
"listNotifications": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"object": ConnectRequest,
"payload": "xyz789",
"seenAt": "2007-12-03T10:15:30Z",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
listOrders
Response
Returns [Order]
Arguments
| Name | Description |
|---|---|
filter - OrderFilter
|
filtering options for orders. Default = {} |
first - Int
|
Number of elements to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [OrderingOptions]
|
Options for sorting the results. Default = [ID_ASC] |
Example
Query
query ListOrders(
$filter: OrderFilter,
$first: Int,
$offset: Int,
$orderBy: [OrderingOptions]
) {
listOrders(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
"data": {
"listOrders": [
{
"appliedDiscountId": 4,
"appliedPricelistId": "4",
"buyer": User,
"buyerId": 4,
"buyerName": "abc123",
"cancel": true,
"comment": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "abc123",
"customId": "abc123",
"discountAmount": 123.45,
"discountType": "abc123",
"drop": Drop,
"dropId": "4",
"extraCosts": 123.45,
"id": "4",
"inform": true,
"invoiceDate": "2007-12-03",
"invoiceNo": "xyz789",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "xyz789",
"rangeOrderText": "xyz789",
"rating": 123,
"rep": User,
"repId": "4",
"rows": [OrderRow],
"sellerId": "4",
"shippingCosts": 123.45,
"status": true,
"sumOfProducts": 987.65,
"supplierName": "abc123",
"totalAmount": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 987.65
}
]
}
}
listPartnerIntegrations
Description
query for getting a list of partner integrations
Response
Returns [PartnerIntegration]
Arguments
| Name | Description |
|---|---|
filter - PartnerIntegrationFilter
|
filter for the partner integrations. Default = {} |
Example
Query
query ListPartnerIntegrations($filter: PartnerIntegrationFilter) {
listPartnerIntegrations(filter: $filter) {
id
listConfigurations {
...IntegrationConfigurationFragment
}
name
owner {
...UserFragment
}
ownerId
type
}
}
Variables
{"filter": {}}
Response
{
"data": {
"listPartnerIntegrations": [
{
"id": 4,
"listConfigurations": [IntegrationConfiguration],
"name": "xyz789",
"owner": User,
"ownerId": 4,
"type": "abc123"
}
]
}
}
listPartners
Description
Get a list of partner accounts
Response
Returns [User]
Example
Query
query ListPartners(
$first: Int,
$offset: Int
) {
listPartners(
first: $first,
offset: $offset
) {
canSearch
contacts {
...ContactFragment
}
discoverable
displayName
emailProfile
facebook
id
image
imageMood
images
img
imgMood
info
instagram
name
phone
plans {
...UserPlanFragment
}
setting {
...SettingFragment
}
twitter
url
urlName
urlkey
}
}
Variables
{"first": 10, "offset": 0}
Response
{
"data": {
"listPartners": [
{
"canSearch": true,
"contacts": [Contact],
"discoverable": false,
"displayName": "xyz789",
"emailProfile": "xyz789",
"facebook": "abc123",
"id": 4,
"image": "abc123",
"imageMood": "abc123",
"images": ["abc123"],
"img": ["abc123"],
"imgMood": ["abc123"],
"info": "abc123",
"instagram": "abc123",
"name": "abc123",
"phone": "abc123",
"plans": [UserPlan],
"setting": Setting,
"twitter": "abc123",
"url": "xyz789",
"urlName": "abc123",
"urlkey": "abc123"
}
]
}
}
listPaymentSubscriptions
Description
Retrieve list a paginated list of drops
Response
Returns [PaymentSubscription]
Arguments
| Name | Description |
|---|---|
filter - PaymentSubscriptionFilter
|
Filters to be applied on the drops query. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [PaymentSubscriptionModelOrder]
|
Options for sorting the results. Default = [ID_ASC] |
Example
Query
query ListPaymentSubscriptions(
$filter: PaymentSubscriptionFilter,
$first: Int,
$offset: Int,
$orderBy: [PaymentSubscriptionModelOrder]
) {
listPaymentSubscriptions(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
id
stripeCustomerId
stripeProductId
stripeSubscriptionId
stripeSubscriptionStatus
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
"data": {
"listPaymentSubscriptions": [
{
"id": "4",
"stripeCustomerId": "xyz789",
"stripeProductId": "abc123",
"stripeSubscriptionId": "xyz789",
"stripeSubscriptionStatus": "abc123"
}
]
}
}
listPlanChangeRequests
Description
List plan change requests
Response
Returns [PlanChangeRequest]
Arguments
| Name | Description |
|---|---|
filter - PlanChangeRequestFilter
|
Filters to be applied to the query results. Default = {acceptedAt: {exists: false}} |
first - Int
|
Number of elements to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [PlanChangeRequestModelOrder]
|
Order to be applied to the query results. Default = [ID_DESC] |
Example
Query
query ListPlanChangeRequests(
$filter: PlanChangeRequestFilter,
$first: Int,
$offset: Int,
$orderBy: [PlanChangeRequestModelOrder]
) {
listPlanChangeRequests(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
acceptedAt
acceptedBy
id
plan {
...PlanFragment
}
planId
userId
}
}
Variables
{
"filter": {"acceptedAt": {"exists": "false"}},
"first": 25,
"offset": 0,
"orderBy": ["ID_DESC"]
}
Response
{
"data": {
"listPlanChangeRequests": [
{
"acceptedAt": "2007-12-03T10:15:30Z",
"acceptedBy": 4,
"id": "4",
"plan": Plan,
"planId": 4,
"userId": 4
}
]
}
}
listPlans
Description
List plans with pagination and filtering
Response
Returns [Plan]
Arguments
| Name | Description |
|---|---|
filter - PlanFilter
|
Filters to be applied to the query results. Default = {} |
first - Int
|
Number of elements to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [PlanModelOrder]
|
Order to be applied to the query results. Default = [ID_ASC] |
Example
Query
query ListPlans(
$filter: PlanFilter,
$first: Int,
$offset: Int,
$orderBy: [PlanModelOrder]
) {
listPlans(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
accountType
description
id
name
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
"data": {
"listPlans": [
{
"accountType": "abc123",
"description": "xyz789",
"id": "4",
"name": "xyz789"
}
]
}
}
listPricelists
Description
list pricelists
Response
Returns [Pricelist]
Arguments
| Name | Description |
|---|---|
filter - PricelistFilter
|
filtering options for orders. Default = {} |
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [PricelistOrderingOptions]
|
Options for sorting the results. Default = [ID_ASC] |
Example
Query
query ListPricelists(
$filter: PricelistFilter,
$first: Int,
$offset: Int,
$orderBy: [PricelistOrderingOptions]
) {
listPricelists(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
_access {
..._PricelistAccessMetaFragment
}
_values {
..._PricelistValueMetaFragment
}
access {
...PricelistAccessFragment
}
currency
drop {
...DropFragment
}
dropId
dropName
id
name
owner {
...UserFragment
}
ownerId
status
type
urlkey
values {
...PricelistValueFragment
}
}
}
Variables
{"filter": {}, "first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
"data": {
"listPricelists": [
{
"_access": _PricelistAccessMeta,
"_values": _PricelistValueMeta,
"access": [PricelistAccess],
"currency": "abc123",
"drop": Drop,
"dropId": "4",
"dropName": "abc123",
"id": 4,
"name": "xyz789",
"owner": User,
"ownerId": 4,
"status": false,
"type": 123,
"urlkey": "abc123",
"values": [PricelistValue]
}
]
}
}
listProducts
Description
Retrieve a list of products
Response
Returns [Product]
Arguments
| Name | Description |
|---|---|
filter - ProductFilter
|
Filters for the product list. Default = {} |
first - Int
|
Number of elements to retrieve, defaults to 10. Default = 10 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [ProductModelOrder]
|
Options for sorting the results. Default = [ID_DESC] |
Example
Query
query ListProducts(
$filter: ProductFilter,
$first: Int,
$offset: Int,
$orderBy: [ProductModelOrder]
) {
listProducts(
filter: $filter,
first: $first,
offset: $offset,
orderBy: $orderBy
) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"filter": {}, "first": 10, "offset": 0, "orderBy": ["ID_DESC"]}
Response
{
"data": {
"listProducts": [
{
"color": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "abc123",
"customField3": "xyz789",
"customField4": "xyz789",
"customField5": "xyz789",
"customField6": "xyz789",
"customField7": "xyz789",
"customField8": "abc123",
"customId": "xyz789",
"customIdInt": "abc123",
"customIdText": "xyz789",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["abc123"],
"img": "xyz789",
"info": "xyz789",
"inventoryStock": "abc123",
"inventoryStockLimit": "abc123",
"material": "abc123",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "xyz789",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "xyz789",
"optionValue5": "xyz789",
"origin": "xyz789",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": "4",
"parentOrChild": "xyz789",
"price": 123.45,
"rangeProductInt": "abc123",
"rangeProductText": "xyz789",
"rrp": "abc123",
"sku": "xyz789",
"soldOut": true,
"supplier": Contact,
"supplierId": "4",
"supplierName": "xyz789",
"taric": "abc123",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
]
}
}
listSystemCurrencyCodes
Description
Retrive a list of 3 character currency codes used by the order41 system
Response
Returns [String]
Example
Query
query ListSystemCurrencyCodes {
listSystemCurrencyCodes
}
Response
{
"data": {
"listSystemCurrencyCodes": ["xyz789"]
}
}
listTeamUsers
Description
List teamUsers
Response
Returns [TeamUser]
Arguments
| Name | Description |
|---|---|
first - Int
|
Number of elemts to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderBy - [TeamUserModelOrder]
|
Options for sorting the results. Default = [ID_ASC] |
Example
Query
query ListTeamUsers(
$first: Int,
$offset: Int,
$orderBy: [TeamUserModelOrder]
) {
listTeamUsers(
first: $first,
offset: $offset,
orderBy: $orderBy
) {
credential {
...CredFragment
}
credentialId
id
role
userId
}
}
Variables
{"first": 25, "offset": 0, "orderBy": ["ID_ASC"]}
Response
{
"data": {
"listTeamUsers": [
{
"credential": Cred,
"credentialId": "4",
"id": 4,
"role": "xyz789",
"userId": "4"
}
]
}
}
listWebhooks
Description
webhoook queries
Response
Returns [Webhook]
Example
Query
query ListWebhooks {
listWebhooks {
headers
id
owner {
...UserFragment
}
ownerId
password
url
userName
webhookEvents {
...WebhookEventFragment
}
}
}
Response
{
"data": {
"listWebhooks": [
{
"headers": Json,
"id": "4",
"owner": User,
"ownerId": "4",
"password": "abc123",
"url": "abc123",
"userName": "xyz789",
"webhookEvents": [WebhookEvent]
}
]
}
}
listWorkspaces
Response
Returns [User]
Example
Query
query ListWorkspaces {
listWorkspaces {
canSearch
contacts {
...ContactFragment
}
discoverable
displayName
emailProfile
facebook
id
image
imageMood
images
img
imgMood
info
instagram
name
phone
plans {
...UserPlanFragment
}
setting {
...SettingFragment
}
twitter
url
urlName
urlkey
}
}
Response
{
"data": {
"listWorkspaces": [
{
"canSearch": false,
"contacts": [Contact],
"discoverable": false,
"displayName": "xyz789",
"emailProfile": "abc123",
"facebook": "xyz789",
"id": "4",
"image": "abc123",
"imageMood": "abc123",
"images": ["xyz789"],
"img": ["xyz789"],
"imgMood": ["xyz789"],
"info": "xyz789",
"instagram": "xyz789",
"name": "xyz789",
"phone": "xyz789",
"plans": [UserPlan],
"setting": Setting,
"twitter": "abc123",
"url": "abc123",
"urlName": "xyz789",
"urlkey": "abc123"
}
]
}
}
orderStatistics
Description
Get statistical data for a list of orders.
Response
Returns an OrderStatistics
Arguments
| Name | Description |
|---|---|
filter - OrderFilter
|
filtering options for orders. Default = {} |
Example
Query
query OrderStatistics($filter: OrderFilter) {
orderStatistics(filter: $filter) {
amountBySupplier {
...AmountBySupplierFragment
}
totalAmount
totalOrderedItems
}
}
Variables
{"filter": {}}
Response
{
"data": {
"orderStatistics": {
"amountBySupplier": [AmountBySupplier],
"totalAmount": 123.45,
"totalOrderedItems": 123.45
}
}
}
orders
Use listOrders instead
Description
Get a list of orders
Response
Returns [Order]
Arguments
| Name | Description |
|---|---|
first - Int
|
Number of elements to retrieve, defaults to 25. Default = 25 |
offset - Int
|
Number of first elements to be left out, defaults to 0. Default = 0 |
orderFilter - OrderFilter
|
filtering options for orders. Default = {} |
Example
Query
query Orders(
$first: Int,
$offset: Int,
$orderFilter: OrderFilter
) {
orders(
first: $first,
offset: $offset,
orderFilter: $orderFilter
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"first": 25, "offset": 0, "orderFilter": {}}
Response
{
"data": {
"orders": [
{
"appliedDiscountId": 4,
"appliedPricelistId": "4",
"buyer": User,
"buyerId": "4",
"buyerName": "xyz789",
"cancel": true,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "abc123",
"customDiscount": "abc123",
"customId": "abc123",
"discountAmount": 987.65,
"discountType": "abc123",
"drop": Drop,
"dropId": "4",
"extraCosts": 123.45,
"id": 4,
"inform": true,
"invoiceDate": "2007-12-03",
"invoiceNo": "xyz789",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "abc123",
"owner": User,
"ownerId": 4,
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 987.65,
"rangeOrderInt": "xyz789",
"rangeOrderText": "abc123",
"rating": 987,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": 4,
"shippingCosts": 987.65,
"status": false,
"sumOfProducts": 123.45,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 123.45
}
]
}
}
ordersByIds
Description
Get a list of orders by ids
Example
Query
query OrdersByIds($orderIds: [ID]) {
ordersByIds(orderIds: $orderIds) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"orderIds": [4]}
Response
{
"data": {
"ordersByIds": [
{
"appliedDiscountId": "4",
"appliedPricelistId": "4",
"buyer": User,
"buyerId": "4",
"buyerName": "abc123",
"cancel": false,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "xyz789",
"customId": "xyz789",
"discountAmount": 123.45,
"discountType": "abc123",
"drop": Drop,
"dropId": "4",
"extraCosts": 987.65,
"id": 4,
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": 4,
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "xyz789",
"rangeOrderText": "xyz789",
"rating": 987,
"rep": User,
"repId": "4",
"rows": [OrderRow],
"sellerId": "4",
"shippingCosts": 987.65,
"status": true,
"sumOfProducts": 987.65,
"supplierName": "xyz789",
"totalAmount": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 987.65
}
]
}
}
products
Use listProducts instead
Description
Get a list of products
Response
Returns [Product]
Example
Query
query Products(
$first: Int,
$offset: Int
) {
products(
first: $first,
offset: $offset
) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"first": 10, "offset": 0}
Response
{
"data": {
"products": [
{
"color": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "xyz789",
"customField3": "abc123",
"customField4": "xyz789",
"customField5": "abc123",
"customField6": "abc123",
"customField7": "xyz789",
"customField8": "xyz789",
"customId": "abc123",
"customIdInt": "xyz789",
"customIdText": "abc123",
"ean": "xyz789",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["abc123"],
"img": "abc123",
"info": "abc123",
"inventoryStock": "xyz789",
"inventoryStockLimit": "xyz789",
"material": "abc123",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "xyz789",
"optionValue2": "abc123",
"optionValue3": "abc123",
"optionValue4": "abc123",
"optionValue5": "abc123",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "xyz789",
"price": 987.65,
"rangeProductInt": "abc123",
"rangeProductText": "abc123",
"rrp": "abc123",
"sku": "abc123",
"soldOut": true,
"supplier": Contact,
"supplierId": "4",
"supplierName": "abc123",
"taric": "abc123",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
]
}
}
recentDrops
Description
Get a list of recent drops from own network
Response
Returns [Drop]
Example
Query
query RecentDrops(
$first: Int,
$offset: Int
) {
recentDrops(
first: $first,
offset: $offset
) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{"first": 3, "offset": 0}
Response
{
"data": {
"recentDrops": [
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 987,
"archive": true,
"asset": "abc123",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "abc123",
"currencyBuy": "abc123",
"currencySell": "abc123",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "xyz789",
"discounts": [Discount],
"discoverable": false,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [123],
"id": 4,
"images": ["xyz789"],
"img": "xyz789",
"info": "abc123",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "abc123",
"openrate": 123,
"order": 123,
"orderItemsQty": 123.45,
"orderQty": 123,
"orderTotal": 123.45,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "xyz789",
"products": [Product],
"public": false,
"publicVisitorCount": 987,
"rangeDropInt": "xyz789",
"rangeDropText": "abc123",
"season": "xyz789",
"status": 123,
"supplier": Contact,
"supplierName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
]
}
}
searchSellerProfiles
Description
Search/query seller profiles.
Example
Query
query SearchSellerProfiles($query: String) {
searchSellerProfiles(query: $query) {
canSearch
contacts {
...ContactFragment
}
discoverable
displayName
emailProfile
facebook
id
image
imageMood
images
img
imgMood
info
instagram
name
phone
plans {
...UserPlanFragment
}
setting {
...SettingFragment
}
twitter
url
urlName
urlkey
}
}
Variables
{"query": "abc123"}
Response
{
"data": {
"searchSellerProfiles": [
{
"canSearch": false,
"contacts": [Contact],
"discoverable": true,
"displayName": "xyz789",
"emailProfile": "xyz789",
"facebook": "xyz789",
"id": 4,
"image": "abc123",
"imageMood": "abc123",
"images": ["xyz789"],
"img": ["xyz789"],
"imgMood": ["xyz789"],
"info": "abc123",
"instagram": "xyz789",
"name": "abc123",
"phone": "abc123",
"plans": [UserPlan],
"setting": Setting,
"twitter": "xyz789",
"url": "xyz789",
"urlName": "xyz789",
"urlkey": "abc123"
}
]
}
}
userProducts
Use listProducts instead
Description
Get a list of products
Response
Returns [UserProduct]
Example
Query
query UserProducts(
$first: Int,
$offset: Int
) {
userProducts(
first: $first,
offset: $offset
) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"first": 10, "offset": 0}
Response
{
"data": {
"userProducts": [
{
"color": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "xyz789",
"customField2": "xyz789",
"customField3": "xyz789",
"customField4": "xyz789",
"customField5": "xyz789",
"customField6": "abc123",
"customField7": "xyz789",
"customField8": "abc123",
"customId": "abc123",
"customIdInt": "xyz789",
"customIdText": "abc123",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": "4",
"images": ["xyz789"],
"img": ["xyz789"],
"info": "abc123",
"inventoryStock": "abc123",
"inventoryStockLimit": "xyz789",
"material": "xyz789",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "xyz789",
"optionValue2": "abc123",
"optionValue3": "abc123",
"optionValue4": "abc123",
"optionValue5": "abc123",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "xyz789",
"price": 987.65,
"rangeProductInt": "abc123",
"rangeProductText": "xyz789",
"rrp": "xyz789",
"sku": "xyz789",
"soldOut": false,
"supplier": Contact,
"supplierId": 4,
"supplierName": "abc123",
"taric": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"variants": [Product],
"variantsV2": [ProductVariant]
}
]
}
}
Mutations
acceptConnectRequest
Description
Accept a connect request
Response
Returns a ConnectRequest
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
mutation AcceptConnectRequest($id: ID) {
acceptConnectRequest(id: $id) {
acceptedAt
createdAt
id
rejectedAt
requesterUser {
...UserFragment
}
source
targetUser {
...UserFragment
}
term
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"acceptConnectRequest": {
"acceptedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"rejectedAt": "2007-12-03T10:15:30Z",
"requesterUser": User,
"source": "abc123",
"targetUser": User,
"term": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
addAccessCustomers
Description
Add accessCustomers.
Response
Returns a Contact
Example
Query
mutation AddAccessCustomers(
$customerIds: [ID],
$id: ID!
) {
addAccessCustomers(
customerIds: $customerIds,
id: $id
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{
"customerIds": ["4"],
"id": "4"
}
Response
{
"data": {
"addAccessCustomers": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "abc123",
"customId": "xyz789",
"defaultSupplier": 123,
"discount": 987.65,
"email": "xyz789",
"id": "4",
"img": ["abc123"],
"invite": true,
"invoiceAddress": "abc123",
"invoiceApartment": "xyz789",
"invoiceCity": "xyz789",
"invoiceCompany": "abc123",
"invoiceCountry": "xyz789",
"invoiceFirstname": "xyz789",
"invoiceLastname": "abc123",
"invoicePostalcode": "abc123",
"invoiceRegion": "xyz789",
"isSuperman": false,
"isSuperwoman": true,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "xyz789",
"name": "abc123",
"notes": "xyz789",
"ownerId": "4",
"paymentBankCustom": "xyz789",
"paymentEmail": "xyz789",
"paymentIbanCustom": "xyz789",
"paymentMethod": "abc123",
"paymentTaxCode": "abc123",
"paymentVatCustom": "abc123",
"phone": "xyz789",
"shippingAddress": "abc123",
"shippingApartment": "abc123",
"shippingCity": "xyz789",
"shippingCompany": "xyz789",
"shippingCountry": "xyz789",
"shippingFirstname": "abc123",
"shippingLastname": "xyz789",
"shippingPostalcode": "abc123",
"shippingRegion": "xyz789",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 987,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "xyz789"
}
}
}
addAccessSuppliers
Description
Add accessSuppliers.
Response
Returns a Contact
Example
Query
mutation AddAccessSuppliers(
$id: ID!,
$supplierIds: [ID]
) {
addAccessSuppliers(
id: $id,
supplierIds: $supplierIds
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{
"id": "4",
"supplierIds": ["4"]
}
Response
{
"data": {
"addAccessSuppliers": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": "4",
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 987,
"discount": 123.45,
"email": "abc123",
"id": "4",
"img": ["xyz789"],
"invite": false,
"invoiceAddress": "abc123",
"invoiceApartment": "abc123",
"invoiceCity": "abc123",
"invoiceCompany": "abc123",
"invoiceCountry": "abc123",
"invoiceFirstname": "xyz789",
"invoiceLastname": "abc123",
"invoicePostalcode": "xyz789",
"invoiceRegion": "xyz789",
"isSuperman": true,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "abc123",
"name": "xyz789",
"notes": "xyz789",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "xyz789",
"paymentMethod": "abc123",
"paymentTaxCode": "abc123",
"paymentVatCustom": "abc123",
"phone": "abc123",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "abc123",
"shippingCompany": "abc123",
"shippingCountry": "abc123",
"shippingFirstname": "xyz789",
"shippingLastname": "abc123",
"shippingPostalcode": "abc123",
"shippingRegion": "abc123",
"showConnectButton": true,
"showPaymentTaxCode": true,
"status": 987,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "abc123"
}
}
}
addDiscount
Description
Add a discount to the drop
Response
Returns a DropDiscount
Example
Query
mutation AddDiscount(
$discountId: ID!,
$dropId: ID!
) {
addDiscount(
discountId: $discountId,
dropId: $dropId
) {
discount {
...DiscountFragment
}
drop {
...DropFragment
}
id
}
}
Variables
{
"discountId": "4",
"dropId": "4"
}
Response
{
"data": {
"addDiscount": {
"discount": Discount,
"drop": Drop,
"id": "4"
}
}
}
addProductToOrder
Response
Returns an Order
Example
Query
mutation AddProductToOrder(
$id: ID,
$productId: ID,
$quantity: Float,
$urlkey: String
) {
addProductToOrder(
id: $id,
productId: $productId,
quantity: $quantity,
urlkey: $urlkey
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{
"id": 4,
"productId": "4",
"quantity": 123.45,
"urlkey": "xyz789"
}
Response
{
"data": {
"addProductToOrder": {
"appliedDiscountId": "4",
"appliedPricelistId": 4,
"buyer": User,
"buyerId": 4,
"buyerName": "abc123",
"cancel": true,
"comment": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "abc123",
"customDiscount": "xyz789",
"customId": "xyz789",
"discountAmount": 123.45,
"discountType": "xyz789",
"drop": Drop,
"dropId": 4,
"extraCosts": 987.65,
"id": 4,
"inform": true,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "abc123",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 987.65,
"rangeOrderInt": "xyz789",
"rangeOrderText": "xyz789",
"rating": 123,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": 4,
"shippingCosts": 987.65,
"status": true,
"sumOfProducts": 987.65,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 987.65
}
}
}
addProductsToDrop
Response
Returns an Int
Example
Query
mutation AddProductsToDrop(
$dropId: ID,
$productIds: [ID]
) {
addProductsToDrop(
dropId: $dropId,
productIds: $productIds
)
}
Variables
{"dropId": 4, "productIds": ["4"]}
Response
{"data": {"addProductsToDrop": 987}}
addTeamUser
Description
Add teamUser
Response
Returns a TeamUser
Arguments
| Name | Description |
|---|---|
email - String
|
|
role - TeamRoleType
|
Default = ADMIN |
Example
Query
mutation AddTeamUser(
$email: String,
$role: TeamRoleType
) {
addTeamUser(
email: $email,
role: $role
) {
credential {
...CredFragment
}
credentialId
id
role
userId
}
}
Variables
{"email": "abc123", "role": "ADMIN"}
Response
{
"data": {
"addTeamUser": {
"credential": Cred,
"credentialId": 4,
"id": "4",
"role": "abc123",
"userId": 4
}
}
}
addToCart
Description
Add products to an existing or new cart
Response
Returns a Cart
Arguments
| Name | Description |
|---|---|
cartProduct - AddToCartInput
|
|
input - AddToCartInput
|
Example
Query
mutation AddToCart(
$cartProduct: AddToCartInput,
$input: AddToCartInput
) {
addToCart(
cartProduct: $cartProduct,
input: $input
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{
"cartProduct": AddToCartInput,
"input": AddToCartInput
}
Response
{
"data": {
"addToCart": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": "4",
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "abc123",
"drop": Drop,
"dropId": "4",
"guestId": 4,
"id": 4,
"isPrivate": false,
"ownerId": "4",
"parentProducts": [CartProduct],
"repId": 4,
"seller": User,
"sellerId": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
}
}
addWebhookEvents
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
webhookEvents - [WebhookEventInput]
|
webhook events |
webhookId - ID!
|
webhook id |
Example
Query
mutation AddWebhookEvents(
$webhookEvents: [WebhookEventInput],
$webhookId: ID!
) {
addWebhookEvents(
webhookEvents: $webhookEvents,
webhookId: $webhookId
)
}
Variables
{
"webhookEvents": [WebhookEventInput],
"webhookId": "4"
}
Response
{"data": {"addWebhookEvents": 123}}
autoGenerateCart
Description
Generates a sugestion for a cart
Response
Returns a Cart
Example
Query
mutation AutoGenerateCart(
$buyerId: ID,
$dropId: ID!
) {
autoGenerateCart(
buyerId: $buyerId,
dropId: $dropId
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{"buyerId": "4", "dropId": 4}
Response
{
"data": {
"autoGenerateCart": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": "4",
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "xyz789",
"drop": Drop,
"dropId": "4",
"guestId": 4,
"id": 4,
"isPrivate": false,
"ownerId": 4,
"parentProducts": [CartProduct],
"repId": "4",
"seller": User,
"sellerId": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
}
}
bulkProductImportSampleFile
Description
Bulk product import sample file.
Response
Returns an Url
Example
Query
mutation BulkProductImportSampleFile {
bulkProductImportSampleFile {
url
}
}
Response
{
"data": {
"bulkProductImportSampleFile": {
"url": "xyz789"
}
}
}
copyDemoAccount
Description
Copy a user account
Response
Returns a BackgroundJob
Example
Query
mutation CopyDemoAccount(
$email: String!,
$urlkey: String!
) {
copyDemoAccount(
email: $email,
urlkey: $urlkey
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{
"email": "abc123",
"urlkey": "abc123"
}
Response
{
"data": {
"copyDemoAccount": {
"completedAt": "2007-12-03T10:15:30Z",
"contactId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"dropId": 4,
"id": "4",
"orderId": "4",
"result": "xyz789",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
copyDrop
Description
starts the bg job for copying a drop returns the related job id
Response
Returns a BackgroundJob
Example
Query
mutation CopyDrop(
$dropUrlkey: String!,
$targetUserUrlkey: String!
) {
copyDrop(
dropUrlkey: $dropUrlkey,
targetUserUrlkey: $targetUserUrlkey
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{
"dropUrlkey": "abc123",
"targetUserUrlkey": "xyz789"
}
Response
{
"data": {
"copyDrop": {
"completedAt": "2007-12-03T10:15:30Z",
"contactId": "4",
"createdAt": "2007-12-03T10:15:30Z",
"dropId": "4",
"id": "4",
"orderId": 4,
"result": "abc123",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
createCartFromOrder
Description
Create cart from an order
Response
Returns a Cart
Example
Query
mutation CreateCartFromOrder(
$id: ID,
$urlkey: String
) {
createCartFromOrder(
id: $id,
urlkey: $urlkey
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
"data": {
"createCartFromOrder": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": 4,
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "abc123",
"drop": Drop,
"dropId": 4,
"guestId": "4",
"id": 4,
"isPrivate": false,
"ownerId": 4,
"parentProducts": [CartProduct],
"repId": "4",
"seller": User,
"sellerId": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
}
}
createContact
Use createContactV2 instead
Description
create contacts
Response
Returns a ContactPage
Example
Query
mutation CreateContact(
$email: String,
$name: String,
$sellerUserIds: [Int]
) {
createContact(
email: $email,
name: $name,
sellerUserIds: $sellerUserIds
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
group
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
members
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{
"email": "abc123",
"name": "xyz789",
"sellerUserIds": [""]
}
Response
{
"data": {
"createContact": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": "4",
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 987,
"discount": 123.45,
"email": "xyz789",
"group": 987,
"id": "4",
"img": ["xyz789"],
"invite": true,
"invoiceAddress": "abc123",
"invoiceApartment": "xyz789",
"invoiceCity": "abc123",
"invoiceCompany": "abc123",
"invoiceCountry": "abc123",
"invoiceFirstname": "abc123",
"invoiceLastname": "abc123",
"invoicePostalcode": "abc123",
"invoiceRegion": "abc123",
"isSuperman": false,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"members": ["abc123"],
"migrateOldId": "abc123",
"name": "xyz789",
"notes": "xyz789",
"ownerId": "4",
"paymentBankCustom": "xyz789",
"paymentEmail": "abc123",
"paymentIbanCustom": "abc123",
"paymentMethod": "xyz789",
"paymentTaxCode": "abc123",
"paymentVatCustom": "abc123",
"phone": "xyz789",
"shippingAddress": "xyz789",
"shippingApartment": "abc123",
"shippingCity": "abc123",
"shippingCompany": "abc123",
"shippingCountry": "abc123",
"shippingFirstname": "xyz789",
"shippingLastname": "xyz789",
"shippingPostalcode": "abc123",
"shippingRegion": "abc123",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 987,
"termOfPayment": "abc123",
"type": 987,
"urlkey": "xyz789"
}
}
}
createContactV2
Description
Create a contact
Response
Returns a Contact
Arguments
| Name | Description |
|---|---|
data - ContactInput
|
input data for contact |
sellerUserIds - [Int]
|
a list of user ids of sellers (sales reps). Default = [] |
Example
Query
mutation CreateContactV2(
$data: ContactInput,
$sellerUserIds: [Int]
) {
createContactV2(
data: $data,
sellerUserIds: $sellerUserIds
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{"data": ContactInput, "sellerUserIds": [""]}
Response
{
"data": {
"createContactV2": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 123,
"discount": 987.65,
"email": "abc123",
"id": 4,
"img": ["xyz789"],
"invite": true,
"invoiceAddress": "xyz789",
"invoiceApartment": "abc123",
"invoiceCity": "xyz789",
"invoiceCompany": "abc123",
"invoiceCountry": "xyz789",
"invoiceFirstname": "xyz789",
"invoiceLastname": "xyz789",
"invoicePostalcode": "abc123",
"invoiceRegion": "abc123",
"isSuperman": false,
"isSuperwoman": true,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "xyz789",
"name": "xyz789",
"notes": "xyz789",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "abc123",
"paymentMethod": "abc123",
"paymentTaxCode": "abc123",
"paymentVatCustom": "xyz789",
"phone": "abc123",
"shippingAddress": "abc123",
"shippingApartment": "abc123",
"shippingCity": "xyz789",
"shippingCompany": "abc123",
"shippingCountry": "abc123",
"shippingFirstname": "abc123",
"shippingLastname": "abc123",
"shippingPostalcode": "xyz789",
"shippingRegion": "xyz789",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 123,
"termOfPayment": "xyz789",
"type": 987,
"urlkey": "abc123"
}
}
}
createDiscount
Description
Create discount
Response
Returns a Discount
Arguments
| Name | Description |
|---|---|
discount - CreateDiscountInput
|
Example
Query
mutation CreateDiscount($discount: CreateDiscountInput) {
createDiscount(discount: $discount) {
active
applications
fixedAmountValue
id
name
ownerId
percentageValue
quantityOrAmount
status
type
urlkey
xgetyItems
xgetyMinimumAmount
xgetyMinimumQtyItems
xgetyPercentage
}
}
Variables
{"discount": CreateDiscountInput}
Response
{
"data": {
"createDiscount": {
"active": true,
"applications": 987,
"fixedAmountValue": 987.65,
"id": "4",
"name": "xyz789",
"ownerId": "4",
"percentageValue": 987.65,
"quantityOrAmount": 987,
"status": false,
"type": 123,
"urlkey": 4,
"xgetyItems": "abc123",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 987.65,
"xgetyPercentage": 987.65
}
}
}
createDrop
Response
Returns a Drop
Arguments
| Name | Description |
|---|---|
input - DropInput!
|
Data to be filled out for a new drop |
Example
Query
mutation CreateDrop($input: DropInput!) {
createDrop(input: $input) {
_dropProductsMeta {
...ProductsMetaFragment
}
_products {
...ProductsMetaFragment
}
access
archive
asset
assets
assetsArchiveGeneratedAt
assetsArchiveUrl
createdAt
csvSource
currencyBuy
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{"input": DropInput}
Response
{
"data": {
"createDrop": {
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 123,
"archive": true,
"asset": "abc123",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "abc123",
"currencySell": "abc123",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": true,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [123],
"id": "4",
"images": ["abc123"],
"img": "abc123",
"info": "abc123",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "xyz789",
"note": "xyz789",
"openrate": 123,
"order": 123,
"orderItemsQty": 987.65,
"orderQty": 123,
"orderTotal": 123.45,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "xyz789",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "xyz789",
"products": [Product],
"public": false,
"publicVisitorCount": 987,
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"season": "xyz789",
"status": 987,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
}
}
createEvent
Description
Create an event.
Response
Returns an Event
Arguments
| Name | Description |
|---|---|
input - EventInput!
|
Example
Query
mutation CreateEvent($input: EventInput!) {
createEvent(input: $input) {
id
payload
type
}
}
Variables
{"input": EventInput}
Response
{
"data": {
"createEvent": {
"id": "4",
"payload": Json,
"type": "xyz789"
}
}
}
createIntegrationConfiguration
Description
Mutation for creating a integration_configuration
Response
Returns an IntegrationConfiguration
Arguments
| Name | Description |
|---|---|
input - IntegrationConfigurationInput
|
integration configuration input |
Example
Query
mutation CreateIntegrationConfiguration($input: IntegrationConfigurationInput) {
createIntegrationConfiguration(input: $input) {
id
key
partnerIntegrationId
value
}
}
Variables
{"input": IntegrationConfigurationInput}
Response
{
"data": {
"createIntegrationConfiguration": {
"id": 4,
"key": "abc123",
"partnerIntegrationId": "4",
"value": "xyz789"
}
}
}
createOrder
Description
Create order from a Cart id/urlkey and a note
Response
Returns an Order
Example
Query
mutation CreateOrder(
$id: ID,
$note: String,
$rating: Int,
$urlkey: String
) {
createOrder(
id: $id,
note: $note,
rating: $rating,
urlkey: $urlkey
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{
"id": "4",
"note": "xyz789",
"rating": 987,
"urlkey": "abc123"
}
Response
{
"data": {
"createOrder": {
"appliedDiscountId": "4",
"appliedPricelistId": "4",
"buyer": User,
"buyerId": 4,
"buyerName": "abc123",
"cancel": true,
"comment": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "xyz789",
"customId": "abc123",
"discountAmount": 123.45,
"discountType": "abc123",
"drop": Drop,
"dropId": 4,
"extraCosts": 987.65,
"id": 4,
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "xyz789",
"rangeOrderText": "abc123",
"rating": 123,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": "4",
"shippingCosts": 123.45,
"status": false,
"sumOfProducts": 123.45,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"vat": 987.65
}
}
}
createOrderExtraCost
Response
Returns an OrderExtraCost
Arguments
| Name | Description |
|---|---|
data - OrderExtraCostInput
|
Order extra cost input |
orderId - ID!
|
Order ID |
Example
Query
mutation CreateOrderExtraCost(
$data: OrderExtraCostInput,
$orderId: ID!
) {
createOrderExtraCost(
data: $data,
orderId: $orderId
) {
amount
id
name
taxRatio
}
}
Variables
{"data": OrderExtraCostInput, "orderId": 4}
Response
{
"data": {
"createOrderExtraCost": {
"amount": 123.45,
"id": 4,
"name": "abc123",
"taxRatio": 123.45
}
}
}
createPartnerIntegration
Description
Mutation for creating a partner integration
Response
Returns a PartnerIntegration
Arguments
| Name | Description |
|---|---|
input - PartnerIntegrationInput
|
partner integration input |
Example
Query
mutation CreatePartnerIntegration($input: PartnerIntegrationInput) {
createPartnerIntegration(input: $input) {
id
listConfigurations {
...IntegrationConfigurationFragment
}
name
owner {
...UserFragment
}
ownerId
type
}
}
Variables
{"input": PartnerIntegrationInput}
Response
{
"data": {
"createPartnerIntegration": {
"id": 4,
"listConfigurations": [IntegrationConfiguration],
"name": "abc123",
"owner": User,
"ownerId": "4",
"type": "abc123"
}
}
}
createPaymentSubscription
Description
Create paymentSubscription.
Response
Returns a PaymentSubscription
Arguments
| Name | Description |
|---|---|
data - PaymentSubscriptionInput
|
Example
Query
mutation CreatePaymentSubscription($data: PaymentSubscriptionInput) {
createPaymentSubscription(data: $data) {
id
stripeCustomerId
stripeProductId
stripeSubscriptionId
stripeSubscriptionStatus
}
}
Variables
{"data": PaymentSubscriptionInput}
Response
{
"data": {
"createPaymentSubscription": {
"id": 4,
"stripeCustomerId": "xyz789",
"stripeProductId": "abc123",
"stripeSubscriptionId": "xyz789",
"stripeSubscriptionStatus": "abc123"
}
}
}
createPricelist
Description
Create pricelist
Response
Returns a Pricelist
Arguments
| Name | Description |
|---|---|
pricelist - CreatePricelistInput!
|
Example
Query
mutation CreatePricelist($pricelist: CreatePricelistInput!) {
createPricelist(pricelist: $pricelist) {
_access {
..._PricelistAccessMetaFragment
}
_values {
..._PricelistValueMetaFragment
}
access {
...PricelistAccessFragment
}
currency
drop {
...DropFragment
}
dropId
dropName
id
name
owner {
...UserFragment
}
ownerId
status
type
urlkey
values {
...PricelistValueFragment
}
}
}
Variables
{"pricelist": CreatePricelistInput}
Response
{
"data": {
"createPricelist": {
"_access": _PricelistAccessMeta,
"_values": _PricelistValueMeta,
"access": [PricelistAccess],
"currency": "abc123",
"drop": Drop,
"dropId": 4,
"dropName": "xyz789",
"id": 4,
"name": "abc123",
"owner": User,
"ownerId": 4,
"status": false,
"type": 987,
"urlkey": "xyz789",
"values": [PricelistValue]
}
}
}
createPricelistAccess
Description
Create pricelist access
Response
Returns a PricelistAccess
Arguments
| Name | Description |
|---|---|
pricelistAccess - CreatePricelistAccessInput!
|
Example
Query
mutation CreatePricelistAccess($pricelistAccess: CreatePricelistAccessInput!) {
createPricelistAccess(pricelistAccess: $pricelistAccess) {
accessType
contact {
...ContactFragment
}
contactId
contactUserId
drop {
...DropFragment
}
dropId
id
ownerId
pricelistId
}
}
Variables
{"pricelistAccess": CreatePricelistAccessInput}
Response
{
"data": {
"createPricelistAccess": {
"accessType": 987,
"contact": Contact,
"contactId": 4,
"contactUserId": 4,
"drop": Drop,
"dropId": "4",
"id": "4",
"ownerId": "4",
"pricelistId": "4"
}
}
}
createPricelistValue
Description
Create pricelist value
Response
Returns a PricelistValue
Arguments
| Name | Description |
|---|---|
pricelistValue - CreatePricelistValueInput!
|
Example
Query
mutation CreatePricelistValue($pricelistValue: CreatePricelistValueInput!) {
createPricelistValue(pricelistValue: $pricelistValue) {
drop {
...DropFragment
}
dropId
id
ownerId
price
priceList
pricelistId
product {
...ProductFragment
}
productId
rrp
rrpList
}
}
Variables
{"pricelistValue": CreatePricelistValueInput}
Response
{
"data": {
"createPricelistValue": {
"drop": Drop,
"dropId": "4",
"id": 4,
"ownerId": "4",
"price": 123.45,
"priceList": 123.45,
"pricelistId": "4",
"product": Product,
"productId": "4",
"rrp": "abc123",
"rrpList": "abc123"
}
}
}
createProduct
Description
Create product.
Response
Returns a Product
Arguments
| Name | Description |
|---|---|
data - ProductInput
|
Product input |
Example
Query
mutation CreateProduct($data: ProductInput) {
createProduct(data: $data) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"data": ProductInput}
Response
{
"data": {
"createProduct": {
"color": "abc123",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "abc123",
"customField3": "abc123",
"customField4": "xyz789",
"customField5": "abc123",
"customField6": "xyz789",
"customField7": "abc123",
"customField8": "abc123",
"customId": "xyz789",
"customIdInt": "xyz789",
"customIdText": "abc123",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["abc123"],
"img": "abc123",
"info": "xyz789",
"inventoryStock": "abc123",
"inventoryStockLimit": "xyz789",
"material": "xyz789",
"name": "abc123",
"optionGroups": [ProductOptionGroup],
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "xyz789",
"optionValue4": "abc123",
"optionValue5": "abc123",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "abc123",
"price": 987.65,
"rangeProductInt": "xyz789",
"rangeProductText": "abc123",
"rrp": "xyz789",
"sku": "abc123",
"soldOut": false,
"supplier": Contact,
"supplierId": "4",
"supplierName": "abc123",
"taric": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
}
}
createProductInBackground
Description
Create product in a backround job.
Response
Returns a BackgroundJob
Arguments
| Name | Description |
|---|---|
data - ProductInput
|
Product input |
Example
Query
mutation CreateProductInBackground($data: ProductInput) {
createProductInBackground(data: $data) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"data": ProductInput}
Response
{
"data": {
"createProductInBackground": {
"completedAt": "2007-12-03T10:15:30Z",
"contactId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"dropId": 4,
"id": 4,
"orderId": "4",
"result": "xyz789",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
createProductOptions
Description
Create product options.
Response
Returns [ProductOption]
Example
Query
mutation CreateProductOptions(
$groupId: ID!,
$names: [String]
) {
createProductOptions(
groupId: $groupId,
names: $names
) {
id
name
order
}
}
Variables
{
"groupId": "4",
"names": ["xyz789"]
}
Response
{
"data": {
"createProductOptions": [
{
"id": 4,
"name": "abc123",
"order": 123
}
]
}
}
createProductVariants
Description
Create product variants.
Response
Returns [ProductVariant]
Arguments
| Name | Description |
|---|---|
parentId - ID!
|
Parent product id |
variants - [ProductVariantInput]
|
Product variants data |
Example
Query
mutation CreateProductVariants(
$parentId: ID!,
$variants: [ProductVariantInput]
) {
createProductVariants(
parentId: $parentId,
variants: $variants
) {
color
cost
createdAt
id
inventoryStock
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
parent {
...ProductFragment
}
parentId
price
rowOrder
rrp
sku
updatedAt
}
}
Variables
{"parentId": 4, "variants": [ProductVariantInput]}
Response
{
"data": {
"createProductVariants": [
{
"color": "abc123",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"inventoryStock": "abc123",
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "xyz789",
"optionValue5": "abc123",
"parent": Product,
"parentId": 4,
"price": 987.65,
"rowOrder": 987,
"rrp": "xyz789",
"sku": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
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": "abc123",
"userName": "abc123",
"webhookEvents": [WebhookEvent]
}
}
}
deleteCart
Description
Delete single Cart by ID or urlkey
Response
Returns a Cart
Example
Query
mutation DeleteCart(
$id: ID,
$urlkey: String
) {
deleteCart(
id: $id,
urlkey: $urlkey
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "abc123"
}
Response
{
"data": {
"deleteCart": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": 4,
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "xyz789",
"drop": Drop,
"dropId": 4,
"guestId": "4",
"id": "4",
"isPrivate": false,
"ownerId": 4,
"parentProducts": [CartProduct],
"repId": 4,
"seller": User,
"sellerId": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
}
}
deleteContact
Description
delete contact
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": false,
"applications": 123,
"fixedAmountValue": 987.65,
"id": "4",
"name": "xyz789",
"ownerId": 4,
"percentageValue": 987.65,
"quantityOrAmount": 123,
"status": false,
"type": 123,
"urlkey": "4",
"xgetyItems": "xyz789",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 123.45,
"xgetyPercentage": 987.65
}
]
}
}
deleteDrop
Description
delete a Drop by ID
Response
Returns a 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
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"deleteDrop": {
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 123,
"archive": true,
"asset": "xyz789",
"assets": ["xyz789"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "abc123",
"currencyBuy": "abc123",
"currencySell": "abc123",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": true,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "xyz789",
"discounts": [Discount],
"discoverable": false,
"dropProducts": [DropProduct],
"filter": 987,
"filters": [987],
"id": "4",
"images": ["abc123"],
"img": "xyz789",
"info": "abc123",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "xyz789",
"openrate": 123,
"order": 987,
"orderItemsQty": 123.45,
"orderQty": 987,
"orderTotal": 123.45,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "abc123",
"products": [Product],
"public": false,
"publicVisitorCount": 987,
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"season": "abc123",
"status": 123,
"supplier": Contact,
"supplierName": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
}
}
deleteExternalProduct
Description
delete external products (and variants)
Response
Returns an Int
Example
Query
mutation DeleteExternalProduct(
$partnerIntegrationId: ID,
$productId: ID
) {
deleteExternalProduct(
partnerIntegrationId: $partnerIntegrationId,
productId: $productId
)
}
Variables
{
"partnerIntegrationId": "4",
"productId": 4
}
Response
{"data": {"deleteExternalProduct": 987}}
deleteIntegration
Description
Removes integration by id
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"
}
}
}
deleteOrder
Description
delete an order by ID or urlkey
Response
Returns an Order
Example
Query
mutation DeleteOrder(
$id: ID,
$urlkey: String
) {
deleteOrder(
id: $id,
urlkey: $urlkey
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
"data": {
"deleteOrder": {
"appliedDiscountId": 4,
"appliedPricelistId": "4",
"buyer": User,
"buyerId": 4,
"buyerName": "abc123",
"cancel": true,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "abc123",
"customId": "xyz789",
"discountAmount": 987.65,
"discountType": "xyz789",
"drop": Drop,
"dropId": "4",
"extraCosts": 123.45,
"id": 4,
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": true,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "abc123",
"owner": User,
"ownerId": 4,
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "abc123",
"rangeOrderText": "xyz789",
"rating": 123,
"rep": User,
"repId": "4",
"rows": [OrderRow],
"sellerId": "4",
"shippingCosts": 987.65,
"status": false,
"sumOfProducts": 123.45,
"supplierName": "xyz789",
"totalAmount": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 987.65
}
}
}
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": "xyz789",
"taxRatio": 123.45
}
}
}
deletePaymentSubscription
Description
Delete paymentSubscription.
Response
Returns a PaymentSubscription
Arguments
| Name | Description |
|---|---|
id - ID
|
Example
Query
mutation DeletePaymentSubscription($id: ID) {
deletePaymentSubscription(id: $id) {
id
stripeCustomerId
stripeProductId
stripeSubscriptionId
stripeSubscriptionStatus
}
}
Variables
{"id": "4"}
Response
{
"data": {
"deletePaymentSubscription": {
"id": 4,
"stripeCustomerId": "xyz789",
"stripeProductId": "abc123",
"stripeSubscriptionId": "xyz789",
"stripeSubscriptionStatus": "abc123"
}
}
}
deletePricelist
Description
Delete pricelist
deletePricelistAccess
Description
Delete pricelist access
Response
Returns a PricelistAccess
Example
Query
mutation DeletePricelistAccess(
$contactId: ID,
$id: ID,
$pricelistId: ID
) {
deletePricelistAccess(
contactId: $contactId,
id: $id,
pricelistId: $pricelistId
) {
accessType
contact {
...ContactFragment
}
contactId
contactUserId
drop {
...DropFragment
}
dropId
id
ownerId
pricelistId
}
}
Variables
{
"contactId": 4,
"id": "4",
"pricelistId": "4"
}
Response
{
"data": {
"deletePricelistAccess": {
"accessType": 987,
"contact": Contact,
"contactId": "4",
"contactUserId": "4",
"drop": Drop,
"dropId": 4,
"id": "4",
"ownerId": 4,
"pricelistId": "4"
}
}
}
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) {
drop {
...DropFragment
}
dropId
id
ownerId
price
priceList
pricelistId
product {
...ProductFragment
}
productId
rrp
rrpList
}
}
Variables
{"id": 4}
Response
{
"data": {
"deletePricelistValue": {
"drop": Drop,
"dropId": "4",
"id": "4",
"ownerId": "4",
"price": 987.65,
"priceList": 987.65,
"pricelistId": "4",
"product": Product,
"productId": 4,
"rrp": "abc123",
"rrpList": "abc123"
}
}
}
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
createdAt
id
inventoryStock
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
parent {
...ProductFragment
}
parentId
price
rowOrder
rrp
sku
updatedAt
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"deleteProductVariants": [
{
"color": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"inventoryStock": "xyz789",
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "xyz789",
"optionValue5": "xyz789",
"parent": Product,
"parentId": "4",
"price": 123.45,
"rowOrder": 987,
"rrp": "abc123",
"sku": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
deleteProducts
Description
Delete products.
Example
Query
mutation DeleteProducts($id: IdFilter) {
deleteProducts(id: $id) {
color
cost
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"id": IdFilter}
Response
{
"data": {
"deleteProducts": [
{
"color": "xyz789",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "xyz789",
"customField3": "xyz789",
"customField4": "abc123",
"customField5": "xyz789",
"customField6": "abc123",
"customField7": "xyz789",
"customField8": "xyz789",
"customId": "xyz789",
"customIdInt": "xyz789",
"customIdText": "abc123",
"ean": "xyz789",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["xyz789"],
"img": "abc123",
"info": "abc123",
"inventoryStock": "xyz789",
"inventoryStockLimit": "abc123",
"material": "xyz789",
"name": "abc123",
"optionGroups": [ProductOptionGroup],
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "xyz789",
"optionValue5": "abc123",
"origin": "abc123",
"owner": User,
"ownerId": "abc123",
"parent": Product,
"parentId": "4",
"parentOrChild": "abc123",
"price": 987.65,
"rangeProductInt": "xyz789",
"rangeProductText": "abc123",
"rrp": "xyz789",
"sku": "xyz789",
"soldOut": true,
"supplier": Contact,
"supplierId": "4",
"supplierName": "abc123",
"taric": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
]
}
}
deleteTeamUser
Description
Delete teamUser
Example
Query
mutation DeleteTeamUser($id: ID) {
deleteTeamUser(id: $id) {
credential {
...CredFragment
}
credentialId
id
role
userId
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteTeamUser": {
"credential": Cred,
"credentialId": 4,
"id": 4,
"role": "abc123",
"userId": "4"
}
}
}
deleteWebhook
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": "abc123",
"webhookEvents": [WebhookEvent]
}
}
}
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": "abc123",
"id": "4",
"objectType": "abc123",
"webhookId": 4
}
}
}
downloadContacts
Use generateContatsSpreadsheet instead
Description
download contacts
duplicateCart
Description
Duplicate (copy) single Cart by ID or urlkey
Response
Returns a Cart
Example
Query
mutation DuplicateCart(
$id: ID,
$urlkey: String
) {
duplicateCart(
id: $id,
urlkey: $urlkey
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"duplicateCart": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": 4,
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "abc123",
"drop": Drop,
"dropId": 4,
"guestId": 4,
"id": 4,
"isPrivate": true,
"ownerId": 4,
"parentProducts": [CartProduct],
"repId": 4,
"seller": User,
"sellerId": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
}
}
duplicateDrop
Response
Returns a 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
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{
"id": "4",
"urlkey": "abc123"
}
Response
{
"data": {
"duplicateDrop": {
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 123,
"archive": false,
"asset": "xyz789",
"assets": ["xyz789"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "xyz789",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 123,
"filters": [987],
"id": 4,
"images": ["abc123"],
"img": "abc123",
"info": "abc123",
"isPublic": false,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "xyz789",
"note": "xyz789",
"openrate": 987,
"order": 123,
"orderItemsQty": 987.65,
"orderQty": 123,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "abc123",
"products": [Product],
"public": true,
"publicVisitorCount": 123,
"rangeDropInt": "xyz789",
"rangeDropText": "abc123",
"season": "xyz789",
"status": 123,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
}
}
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
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{"data": UpdateProductInput, "id": 4}
Response
{
"data": {
"duplicateProduct": {
"color": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "xyz789",
"customField2": "xyz789",
"customField3": "xyz789",
"customField4": "xyz789",
"customField5": "xyz789",
"customField6": "xyz789",
"customField7": "abc123",
"customField8": "abc123",
"customId": "abc123",
"customIdInt": "abc123",
"customIdText": "abc123",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": "4",
"images": ["abc123"],
"img": "abc123",
"info": "xyz789",
"inventoryStock": "abc123",
"inventoryStockLimit": "xyz789",
"material": "abc123",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "xyz789",
"optionValue4": "xyz789",
"optionValue5": "xyz789",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "abc123",
"price": 987.65,
"rangeProductInt": "xyz789",
"rangeProductText": "xyz789",
"rrp": "xyz789",
"sku": "xyz789",
"soldOut": false,
"supplier": Contact,
"supplierId": 4,
"supplierName": "xyz789",
"taric": "xyz789",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
}
}
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
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
"data": {
"exportProducts": {
"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"
}
}
}
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) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"dropId": 4}
Response
{
"data": {
"generateAssetArchive": {
"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"
}
}
}
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) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"type": "EXCEL"}
Response
{
"data": {
"generateContactsSpreadsheet": {
"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"
}
}
}
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
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
"data": {
"generateDropOrdersOverviewSpreadsheet": {
"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"
}
}
}
generateDropOrdersSpreadsheet
Description
starts the bg job for creating orders_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 GenerateDropOrdersSpreadsheet(
$id: ID!,
$type: SpreadsheetType
) {
generateDropOrdersSpreadsheet(
id: $id,
type: $type
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4", "type": "EXCEL"}
Response
{
"data": {
"generateDropOrdersSpreadsheet": {
"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"
}
}
}
generateDropPdf
Description
generate drop pdf
Response
Returns a BackgroundJob
Arguments
| Name | Description |
|---|---|
dropId - ID
|
drop id |
Example
Query
mutation GenerateDropPdf($dropId: ID) {
generateDropPdf(dropId: $dropId) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"dropId": "4"}
Response
{
"data": {
"generateDropPdf": {
"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"
}
}
}
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) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"generateDropProductsImagesZip": {
"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"
}
}
}
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
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4", "type": "EXCEL"}
Response
{
"data": {
"generateDropProductsSpreadsheet": {
"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"
}
}
}
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
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
"data": {
"generateDropSupplierOrderSpreadsheet": {
"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"
}
}
}
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": "abc123",
"id": "4",
"isValid": true,
"ownerId": 4,
"type": "abc123",
"userId": 987,
"value": "xyz789"
}
}
}
generateInvoice
Response
Returns a BackgroundJob
Example
Query
mutation GenerateInvoice(
$id: ID!,
$type: OrderPdfs
) {
generateInvoice(
id: $id,
type: $type
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": 4, "type": "INVOICE"}
Response
{
"data": {
"generateInvoice": {
"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"
}
}
}
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": "abc123",
"id": "4",
"isValid": true,
"ownerId": "4",
"type": "abc123",
"userId": 123,
"value": "abc123"
}
}
}
generateOrderConfirmationPdf
Response
Returns a BackgroundJob
Arguments
| Name | Description |
|---|---|
id - ID!
|
ID of the order |
Example
Query
mutation GenerateOrderConfirmationPdf($id: ID!) {
generateOrderConfirmationPdf(id: $id) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"generateOrderConfirmationPdf": {
"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"
}
}
}
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
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": 4, "type": "EXCEL"}
Response
{
"data": {
"generateOrderConfirmationSpreadsheet": {
"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"
}
}
}
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"
}
}
}
generatePricelistSpreadsheet
Description
Generate pricelist spreadsheet.
Response
Returns a BackgroundJob
Arguments
| Name | Description |
|---|---|
id - ID
|
Id of a pricelist |
type - SpreadsheetType
|
Default = EXCEL |
urlkey - ID
|
Urlkey of a pricelist |
Example
Query
mutation GeneratePricelistSpreadsheet(
$id: ID,
$type: SpreadsheetType,
$urlkey: ID
) {
generatePricelistSpreadsheet(
id: $id,
type: $type,
urlkey: $urlkey
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4", "type": "EXCEL", "urlkey": 4}
Response
{
"data": {
"generatePricelistSpreadsheet": {
"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"
}
}
}
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) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"fileUrl": "abc123"}
Response
{
"data": {
"importContacts": {
"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"
}
}
}
importPricelist
Description
import pricelist.
Response
Returns a BackgroundJob
Example
Query
mutation ImportPricelist(
$fileUrl: String!,
$id: ID
) {
importPricelist(
fileUrl: $fileUrl,
id: $id
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{
"fileUrl": "xyz789",
"id": "4"
}
Response
{
"data": {
"importPricelist": {
"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"
}
}
}
importProducts
Description
Start import of products.
Response
Returns a BackgroundJob
Example
Query
mutation ImportProducts(
$dropId: ID,
$fileUrl: String!
) {
importProducts(
dropId: $dropId,
fileUrl: $fileUrl
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{
"dropId": "4",
"fileUrl": "xyz789"
}
Response
{
"data": {
"importProducts": {
"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"
}
}
}
integrationToken
Description
Generate/retrieve integration token
invalidateToken
Description
Invalidate token
Response
Returns a String
Example
Query
mutation InvalidateToken {
invalidateToken
}
Response
{"data": {"invalidateToken": "xyz789"}}
inviteContact
Description
Invite contact (or send connect request).
Example
Query
mutation InviteContact($id: ID) {
inviteContact(id: $id) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{"id": 4}
Response
{
"data": {
"inviteContact": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "abc123",
"customId": "xyz789",
"defaultSupplier": 123,
"discount": 987.65,
"email": "abc123",
"id": 4,
"img": ["abc123"],
"invite": false,
"invoiceAddress": "abc123",
"invoiceApartment": "xyz789",
"invoiceCity": "xyz789",
"invoiceCompany": "abc123",
"invoiceCountry": "xyz789",
"invoiceFirstname": "xyz789",
"invoiceLastname": "abc123",
"invoicePostalcode": "xyz789",
"invoiceRegion": "abc123",
"isSuperman": true,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "abc123",
"name": "xyz789",
"notes": "xyz789",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "abc123",
"paymentMethod": "abc123",
"paymentTaxCode": "xyz789",
"paymentVatCustom": "abc123",
"phone": "xyz789",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "xyz789",
"shippingCompany": "abc123",
"shippingCountry": "abc123",
"shippingFirstname": "abc123",
"shippingLastname": "abc123",
"shippingPostalcode": "xyz789",
"shippingRegion": "xyz789",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 987,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "xyz789"
}
}
}
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": "abc123",
"options": {"countryCode": ""},
"password": "abc123"
}
Response
{"data": {"login": "abc123"}}
loginAs
Description
Login as another user
orderDrops
Description
order drops of user
orderProductsImages
Response
Returns a BackgroundJob
Arguments
| Name | Description |
|---|---|
id - ID!
|
ID of the order |
Example
Query
mutation OrderProductsImages($id: ID!) {
orderProductsImages(id: $id) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"orderProductsImages": {
"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"
}
}
}
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) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"email": "abc123"}
Response
{
"data": {
"passwordResetEmail": {
"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"
}
}
}
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"
}
}
}
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": "xyz789"}}
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": "abc123"}}
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": "xyz789"}}
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": "xyz789"}}
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": "abc123"}}
rateDrop
Description
Rate a drop.
Response
Returns a DropRate
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": 123}
}
}
rateOrder
Response
Returns an Order
Example
Query
mutation RateOrder(
$id: ID!,
$rating: Int
) {
rateOrder(
id: $id,
rating: $rating
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"id": "4", "rating": 123}
Response
{
"data": {
"rateOrder": {
"appliedDiscountId": 4,
"appliedPricelistId": 4,
"buyer": User,
"buyerId": 4,
"buyerName": "abc123",
"cancel": false,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "abc123",
"customDiscount": "xyz789",
"customId": "xyz789",
"discountAmount": 987.65,
"discountType": "abc123",
"drop": Drop,
"dropId": "4",
"extraCosts": 123.45,
"id": 4,
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 987.65,
"rangeOrderInt": "abc123",
"rangeOrderText": "abc123",
"rating": 987,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": 4,
"shippingCosts": 987.65,
"status": true,
"sumOfProducts": 123.45,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"vat": 123.45
}
}
}
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": "xyz789",
"seenAt": "2007-12-03T10:15:30Z",
"type": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
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) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{"type": "CONTACTS"}
Response
{
"data": {
"refreshSearch": {
"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"
}
}
}
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": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
removeAccessCustomers
Description
Remove accessCustomers.
Response
Returns a Contact
Example
Query
mutation RemoveAccessCustomers(
$customerIds: [ID],
$id: ID!
) {
removeAccessCustomers(
customerIds: $customerIds,
id: $id
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{"customerIds": [4], "id": "4"}
Response
{
"data": {
"removeAccessCustomers": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "xyz789",
"customId": "xyz789",
"defaultSupplier": 123,
"discount": 123.45,
"email": "xyz789",
"id": 4,
"img": ["xyz789"],
"invite": false,
"invoiceAddress": "xyz789",
"invoiceApartment": "abc123",
"invoiceCity": "abc123",
"invoiceCompany": "xyz789",
"invoiceCountry": "abc123",
"invoiceFirstname": "xyz789",
"invoiceLastname": "xyz789",
"invoicePostalcode": "xyz789",
"invoiceRegion": "xyz789",
"isSuperman": true,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "abc123",
"name": "abc123",
"notes": "xyz789",
"ownerId": "4",
"paymentBankCustom": "xyz789",
"paymentEmail": "abc123",
"paymentIbanCustom": "abc123",
"paymentMethod": "xyz789",
"paymentTaxCode": "xyz789",
"paymentVatCustom": "abc123",
"phone": "abc123",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "abc123",
"shippingCompany": "xyz789",
"shippingCountry": "abc123",
"shippingFirstname": "abc123",
"shippingLastname": "abc123",
"shippingPostalcode": "abc123",
"shippingRegion": "abc123",
"showConnectButton": true,
"showPaymentTaxCode": true,
"status": 123,
"termOfPayment": "abc123",
"type": 987,
"urlkey": "xyz789"
}
}
}
removeAccessSuppliers
Description
Remove accessSuppliers.
Response
Returns a Contact
Example
Query
mutation RemoveAccessSuppliers(
$id: ID!,
$supplierIds: [ID]
) {
removeAccessSuppliers(
id: $id,
supplierIds: $supplierIds
) {
accessCustomers {
...AccessContactFragment
}
accessSuppliers {
...AccessContactFragment
}
contactUser {
...UserFragment
}
contactUserId
currency
customId
defaultSupplier
discount
email
id
img
invite
invoiceAddress
invoiceApartment
invoiceCity
invoiceCompany
invoiceCountry
invoiceFirstname
invoiceLastname
invoicePostalcode
invoiceRegion
isSuperman
isSuperwoman
lastInvite
migrateOldId
name
notes
ownerId
paymentBankCustom
paymentEmail
paymentIbanCustom
paymentMethod
paymentTaxCode
paymentVatCustom
phone
shippingAddress
shippingApartment
shippingCity
shippingCompany
shippingCountry
shippingFirstname
shippingLastname
shippingPostalcode
shippingRegion
showConnectButton
showPaymentTaxCode
status
termOfPayment
type
urlkey
}
}
Variables
{"id": 4, "supplierIds": ["4"]}
Response
{
"data": {
"removeAccessSuppliers": {
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": "4",
"currency": "abc123",
"customId": "xyz789",
"defaultSupplier": 123,
"discount": 123.45,
"email": "xyz789",
"id": 4,
"img": ["xyz789"],
"invite": true,
"invoiceAddress": "abc123",
"invoiceApartment": "xyz789",
"invoiceCity": "xyz789",
"invoiceCompany": "abc123",
"invoiceCountry": "abc123",
"invoiceFirstname": "xyz789",
"invoiceLastname": "xyz789",
"invoicePostalcode": "abc123",
"invoiceRegion": "xyz789",
"isSuperman": true,
"isSuperwoman": true,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "xyz789",
"name": "xyz789",
"notes": "xyz789",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "xyz789",
"paymentMethod": "abc123",
"paymentTaxCode": "xyz789",
"paymentVatCustom": "xyz789",
"phone": "abc123",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "abc123",
"shippingCompany": "xyz789",
"shippingCountry": "xyz789",
"shippingFirstname": "abc123",
"shippingLastname": "xyz789",
"shippingPostalcode": "xyz789",
"shippingRegion": "xyz789",
"showConnectButton": true,
"showPaymentTaxCode": true,
"status": 123,
"termOfPayment": "abc123",
"type": 987,
"urlkey": "xyz789"
}
}
}
removeDiscount
Description
Remove discount from a drop
Response
Returns a DropDiscount
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
}
}
}
removeFromCart
Description
Remove product from a cart
Response
Returns a CartProduct
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": 123.45,
"variants": [CartProduct]
}
}
}
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": "xyz789",
"order": 987
}
}
}
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
}
]
}
}
removeProductsFromDrop
Response
Returns an Int
Example
Query
mutation RemoveProductsFromDrop(
$dropId: ID,
$productIds: [ID]
) {
removeProductsFromDrop(
dropId: $dropId,
productIds: $productIds
)
}
Variables
{"dropId": 4, "productIds": [4]}
Response
{"data": {"removeProductsFromDrop": 987}}
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"
}
}
}
resetPassword
Description
Reset password
Response
Returns a Credential
Example
Query
mutation ResetPassword(
$password: String!,
$token: String!
) {
resetPassword(
password: $password,
token: $token
) {
accountType
email
isAdmin
nlAccept
plan {
...PlanFragment
}
recovery
recoveryInform
representing {
...UserFragment
}
status
userId
welcome
}
}
Variables
{
"password": "abc123",
"token": "abc123"
}
Response
{
"data": {
"resetPassword": {
"accountType": "BUYER",
"email": "xyz789",
"isAdmin": true,
"nlAccept": true,
"plan": Plan,
"recovery": "abc123",
"recoveryInform": false,
"representing": [User],
"status": true,
"userId": 4,
"welcome": false
}
}
}
returnOrderToStock
Description
return order to stock
Response
Returns an Order
Example
Query
mutation ReturnOrderToStock(
$id: ID,
$urlkey: String
) {
returnOrderToStock(
id: $id,
urlkey: $urlkey
) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"id": 4, "urlkey": "xyz789"}
Response
{
"data": {
"returnOrderToStock": {
"appliedDiscountId": "4",
"appliedPricelistId": "4",
"buyer": User,
"buyerId": "4",
"buyerName": "xyz789",
"cancel": false,
"comment": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "xyz789",
"customId": "xyz789",
"discountAmount": 123.45,
"discountType": "xyz789",
"drop": Drop,
"dropId": "4",
"extraCosts": 987.65,
"id": "4",
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": true,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "abc123",
"rangeOrderText": "abc123",
"rating": 123,
"rep": User,
"repId": "4",
"rows": [OrderRow],
"sellerId": "4",
"shippingCosts": 987.65,
"status": false,
"sumOfProducts": 123.45,
"supplierName": "xyz789",
"totalAmount": 987.65,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"vat": 987.65
}
}
}
sendConnectRequest
Description
Send a connect request to user
Response
Returns a ConnectRequest
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": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
sendOrderConfirmation
Description
Trigger resending of order confirmation email
Example
Query
mutation SendOrderConfirmation($id: ID) {
sendOrderConfirmation(id: $id) {
appliedDiscountId
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{"id": "4"}
Response
{
"data": {
"sendOrderConfirmation": {
"appliedDiscountId": "4",
"appliedPricelistId": 4,
"buyer": User,
"buyerId": "4",
"buyerName": "abc123",
"cancel": true,
"comment": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "xyz789",
"customId": "abc123",
"discountAmount": 987.65,
"discountType": "abc123",
"drop": Drop,
"dropId": "4",
"extraCosts": 987.65,
"id": "4",
"inform": true,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "abc123",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 987.65,
"rangeOrderInt": "abc123",
"rangeOrderText": "xyz789",
"rating": 123,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": 4,
"shippingCosts": 123.45,
"status": true,
"sumOfProducts": 123.45,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"vat": 987.65
}
}
}
setUserPlan
Description
Set subscription plan for the current user
Response
Returns a UserPlan
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": "abc123",
"stripeSubscriptionId": "xyz789",
"user": User
}
}
}
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"
}
}
}
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}}}
switchWorkspace
Description
Switch workspace.
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": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
updateCart
Description
update single Cart by ID or urlkey
Response
Returns a Cart
Example
Query
mutation UpdateCart(
$cartData: CartInput,
$id: ID,
$urlkey: String
) {
updateCart(
cartData: $cartData,
id: $id,
urlkey: $urlkey
) {
_cartProductsMeta {
...CartProductsMetaFragment
}
_parentProductsMeta {
...CartProductsMetaFragment
}
buyer {
...UserFragment
}
buyerId
cartProducts {
...CartProductFragment
}
createdAt
creatorType
drop {
...DropFragment
}
dropId
guestId
id
isPrivate
ownerId
parentProducts {
...CartProductFragment
}
repId
seller {
...UserFragment
}
sellerId
updatedAt
urlkey
}
}
Variables
{
"cartData": CartInput,
"id": "4",
"urlkey": "xyz789"
}
Response
{
"data": {
"updateCart": {
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": 4,
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "abc123",
"drop": Drop,
"dropId": "4",
"guestId": 4,
"id": 4,
"isPrivate": false,
"ownerId": 4,
"parentProducts": [CartProduct],
"repId": 4,
"seller": User,
"sellerId": 4,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
}
}
updateCartProduct
Description
Update the quantity of a product in cart
Response
Returns a CartProduct
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": "abc123",
"productId": 4,
"quantity": 123.45
}
Response
{
"data": {
"updateCartProduct": {
"cart": Cart,
"cartId": 4,
"id": "4",
"product": Product,
"productId": "4",
"quantity": 987.65,
"variants": [CartProduct]
}
}
}
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"}}
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": 123,
"fixedAmountValue": 123.45,
"id": 4,
"name": "xyz789",
"ownerId": "4",
"percentageValue": 123.45,
"quantityOrAmount": 987,
"status": true,
"type": 123,
"urlkey": "4",
"xgetyItems": "abc123",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 987.65,
"xgetyPercentage": 987.65
}
}
}
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
currencySell
deadline
deadlineStop
deliveryEnd
deliveryStart
deliveryWindow
discounts {
...DiscountFragment
}
discoverable
dropProducts {
...DropProductFragment
}
filter
filters
id
images
img
info
isPublic
lastPromotion
name
note
openrate
order
orderItemsQty
orderQty
orderTotal
orderTotalArray {
...OrderTotalFragment
}
owner {
...UserFragment
}
ownerId
pdfGeneratedAt
pdfUrl
products {
...ProductFragment
}
public
publicVisitorCount
rangeDropInt
rangeDropText
season
status
supplier {
...ContactFragment
}
supplierName
updatedAt
urlkey
}
}
Variables
{
"dropData": DropInput,
"id": 4,
"urlkey": "abc123"
}
Response
{
"data": {
"updateDrop": {
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 123,
"archive": true,
"asset": "xyz789",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "xyz789",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": true,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropProducts": [DropProduct],
"filter": 987,
"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": 123,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "xyz789",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "xyz789",
"products": [Product],
"public": false,
"publicVisitorCount": 123,
"rangeDropInt": "abc123",
"rangeDropText": "abc123",
"season": "abc123",
"status": 123,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
}
}
updateDropProduct
Description
Updates Drop and product association - currenty only one field rowOrder
Response
Returns a DropProduct
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": 123
}
}
}
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": "abc123",
"partnerIntegrationId": 4,
"value": "xyz789"
}
}
}
updateOrder
use updateOrder2
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"}}
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
appliedPricelistId
buyer {
...UserFragment
}
buyerId
buyerName
cancel
comment
createdAt
currency
customDiscount
customId
discountAmount
discountType
drop {
...DropFragment
}
dropId
extraCosts
id
inform
invoiceDate
invoiceNo
isSeller
orderExtraCosts {
...OrderExtraCostFragment
}
orderMeta {
...OrderMetaFragment
}
orderTag
owner {
...UserFragment
}
ownerId
parentProducts {
...OrderProductFragment
}
products {
...ProductFragment
}
qty
rangeOrderInt
rangeOrderText
rating
rep {
...UserFragment
}
repId
rows {
...OrderRowFragment
}
sellerId
shippingCosts
status
sumOfProducts
supplierName
totalAmount
updatedAt
urlkey
vat
}
}
Variables
{
"data": OrderInput,
"id": "4",
"urlkey": "abc123"
}
Response
{
"data": {
"updateOrder2": {
"appliedDiscountId": "4",
"appliedPricelistId": "4",
"buyer": User,
"buyerId": "4",
"buyerName": "xyz789",
"cancel": false,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "abc123",
"customDiscount": "abc123",
"customId": "abc123",
"discountAmount": 123.45,
"discountType": "xyz789",
"drop": Drop,
"dropId": "4",
"extraCosts": 987.65,
"id": 4,
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "xyz789",
"isSeller": false,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": 4,
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "abc123",
"rangeOrderText": "abc123",
"rating": 987,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": 4,
"shippingCosts": 123.45,
"status": true,
"sumOfProducts": 987.65,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 987.65
}
}
}
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
}
}
}
updatePassword
Description
Update password
Response
Returns a String
Example
Query
mutation UpdatePassword(
$newPassword: String!,
$password: String!
) {
updatePassword(
newPassword: $newPassword,
password: $password
)
}
Variables
{
"newPassword": "abc123",
"password": "abc123"
}
Response
{"data": {"updatePassword": "xyz789"}}
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
stripeProductId
stripeSubscriptionId
stripeSubscriptionStatus
}
}
Variables
{
"data": PaymentSubscriptionInput,
"id": "4"
}
Response
{
"data": {
"updatePaymentSubscription": {
"id": 4,
"stripeCustomerId": "xyz789",
"stripeProductId": "abc123",
"stripeSubscriptionId": "xyz789",
"stripeSubscriptionStatus": "xyz789"
}
}
}
updatePricelist
Description
Update single procelist
Response
Returns a Pricelist
Arguments
| Name | Description |
|---|---|
id - ID!
|
Unique identifier of a pricelist |
pricelist - CreatePricelistInput!
|
Example
Query
mutation UpdatePricelist(
$id: ID!,
$pricelist: CreatePricelistInput!
) {
updatePricelist(
id: $id,
pricelist: $pricelist
) {
_access {
..._PricelistAccessMetaFragment
}
_values {
..._PricelistValueMetaFragment
}
access {
...PricelistAccessFragment
}
currency
drop {
...DropFragment
}
dropId
dropName
id
name
owner {
...UserFragment
}
ownerId
status
type
urlkey
values {
...PricelistValueFragment
}
}
}
Variables
{"id": 4, "pricelist": CreatePricelistInput}
Response
{
"data": {
"updatePricelist": {
"_access": _PricelistAccessMeta,
"_values": _PricelistValueMeta,
"access": [PricelistAccess],
"currency": "abc123",
"drop": Drop,
"dropId": "4",
"dropName": "xyz789",
"id": 4,
"name": "abc123",
"owner": User,
"ownerId": "4",
"status": false,
"type": 123,
"urlkey": "abc123",
"values": [PricelistValue]
}
}
}
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
) {
drop {
...DropFragment
}
dropId
id
ownerId
price
priceList
pricelistId
product {
...ProductFragment
}
productId
rrp
rrpList
}
}
Variables
{
"id": "4",
"pricelistValue": UpdatePricelistValueInput
}
Response
{
"data": {
"updatePricelistValue": {
"drop": Drop,
"dropId": "4",
"id": 4,
"ownerId": 4,
"price": 123.45,
"priceList": 123.45,
"pricelistId": "4",
"product": Product,
"productId": 4,
"rrp": "xyz789",
"rrpList": "xyz789"
}
}
}
updatePricelistValues
Description
Update mulitple pricelist values based on product ID
Response
Returns [PricelistValue]
Arguments
| Name | Description |
|---|---|
pricelistId - ID!
|
Pricelist ID |
values - [UpdatePricelistValueInput]!
|
Example
Query
mutation UpdatePricelistValues(
$pricelistId: ID!,
$values: [UpdatePricelistValueInput]!
) {
updatePricelistValues(
pricelistId: $pricelistId,
values: $values
) {
drop {
...DropFragment
}
dropId
id
ownerId
price
priceList
pricelistId
product {
...ProductFragment
}
productId
rrp
rrpList
}
}
Variables
{
"pricelistId": "4",
"values": [UpdatePricelistValueInput]
}
Response
{
"data": {
"updatePricelistValues": [
{
"drop": Drop,
"dropId": 4,
"id": "4",
"ownerId": 4,
"price": 123.45,
"priceList": 987.65,
"pricelistId": "4",
"product": Product,
"productId": "4",
"rrp": "xyz789",
"rrpList": "abc123"
}
]
}
}
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
createdAt
customField1
customField2
customField3
customField4
customField5
customField6
customField7
customField8
customId
customIdInt
customIdText
ean
externalProducts {
...ExternalProductFragment
}
id
images
img
info
inventoryStock
inventoryStockLimit
material
name
optionGroups {
...ProductOptionGroupFragment
}
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
origin
owner {
...UserFragment
}
ownerId
parent {
...ProductFragment
}
parentId
parentOrChild
price
rangeProductInt
rangeProductText
rrp
sku
soldOut
supplier {
...ContactFragment
}
supplierId
supplierName
taric
type
updatedAt
urlkey
variants {
...ProductFragment
}
variantsV2 {
...ProductVariantFragment
}
}
}
Variables
{
"data": UpdateProductInput,
"id": "4"
}
Response
{
"data": {
"updateProduct": {
"color": "abc123",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "abc123",
"customField3": "abc123",
"customField4": "abc123",
"customField5": "abc123",
"customField6": "xyz789",
"customField7": "xyz789",
"customField8": "abc123",
"customId": "abc123",
"customIdInt": "abc123",
"customIdText": "abc123",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": "4",
"images": ["abc123"],
"img": "xyz789",
"info": "xyz789",
"inventoryStock": "xyz789",
"inventoryStockLimit": "abc123",
"material": "xyz789",
"name": "abc123",
"optionGroups": [ProductOptionGroup],
"optionValue1": "xyz789",
"optionValue2": "abc123",
"optionValue3": "xyz789",
"optionValue4": "xyz789",
"optionValue5": "abc123",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": "4",
"parentOrChild": "abc123",
"price": 123.45,
"rangeProductInt": "xyz789",
"rangeProductText": "xyz789",
"rrp": "abc123",
"sku": "abc123",
"soldOut": true,
"supplier": Contact,
"supplierId": "4",
"supplierName": "abc123",
"taric": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"variants": [Product],
"variantsV2": [ProductVariant]
}
}
}
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
) {
completedAt
contactId
createdAt
dropId
id
orderId
result
type
updatedAt
}
}
Variables
{
"data": ProductInput,
"id": "4"
}
Response
{
"data": {
"updateProductInBackground": {
"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"
}
}
}
updateProductOption
Response
Returns a ProductOption
Example
Query
mutation UpdateProductOption(
$id: ID!,
$name: String
) {
updateProductOption(
id: $id,
name: $name
) {
id
name
order
}
}
Variables
{
"id": "4",
"name": "xyz789"
}
Response
{
"data": {
"updateProductOption": {
"id": 4,
"name": "abc123",
"order": 987
}
}
}
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
createdAt
id
inventoryStock
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
parent {
...ProductFragment
}
parentId
price
rowOrder
rrp
sku
updatedAt
}
}
Variables
{"variants": [ProductVariantUpdateInput]}
Response
{
"data": {
"updateProductVariants": [
{
"color": "xyz789",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"inventoryStock": "xyz789",
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "xyz789",
"optionValue4": "abc123",
"optionValue5": "xyz789",
"parent": Product,
"parentId": "4",
"price": 123.45,
"rowOrder": 987,
"rrp": "xyz789",
"sku": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
updateProfile
Description
Update the user profile data
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
}
twitter
url
urlName
urlkey
}
}
Variables
{"user": UserInput}
Response
{
"data": {
"updateProfile": {
"canSearch": true,
"contacts": [Contact],
"discoverable": false,
"displayName": "abc123",
"emailProfile": "xyz789",
"facebook": "xyz789",
"id": 4,
"image": "xyz789",
"imageMood": "xyz789",
"images": ["xyz789"],
"img": ["xyz789"],
"imgMood": ["xyz789"],
"info": "abc123",
"instagram": "abc123",
"name": "abc123",
"phone": "abc123",
"plans": [UserPlan],
"setting": Setting,
"twitter": "abc123",
"url": "abc123",
"urlName": "xyz789",
"urlkey": "abc123"
}
}
}
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"}}
updateVariantRowOrder
Description
Update variant row_order
Response
Returns a ProductVariant
Example
Query
mutation UpdateVariantRowOrder(
$id: ID!,
$rowOrder: Int
) {
updateVariantRowOrder(
id: $id,
rowOrder: $rowOrder
) {
color
cost
createdAt
id
inventoryStock
optionValue1
optionValue2
optionValue3
optionValue4
optionValue5
parent {
...ProductFragment
}
parentId
price
rowOrder
rrp
sku
updatedAt
}
}
Variables
{"id": "4", "rowOrder": 123}
Response
{
"data": {
"updateVariantRowOrder": {
"color": "xyz789",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"inventoryStock": "xyz789",
"optionValue1": "abc123",
"optionValue2": "abc123",
"optionValue3": "xyz789",
"optionValue4": "abc123",
"optionValue5": "xyz789",
"parent": Product,
"parentId": "4",
"price": 987.65,
"rowOrder": 123,
"rrp": "abc123",
"sku": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
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": "xyz789",
"url": "xyz789",
"userName": "xyz789",
"webhookEvents": [WebhookEvent]
}
}
}
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": 987}}
Types
AccessContact
Description
Access contact
Example
{
"accessContact": Contact,
"accessContactId": "4",
"accessType": 123,
"accessUserId": "4",
"contactId": "4",
"contactUserId": "4",
"ownerId": "4"
}
AccountType
Description
Available account types
Values
| Enum Value | Description |
|---|---|
|
|
Able to find and purchase products from sellers on the platform |
|
|
Lists and sells products through the platform |
|
|
Has access to public profiles and drops |
Example
"BUYER"
AddToCartInput
Description
Type for accepting add to cart attributes
Example
{
"buyerId": 4,
"cartId": "4",
"cartUrlkey": "abc123",
"dropId": 4,
"items": [CartProductInput],
"productId": "4",
"quantity": 123.45
}
AmountBySupplier
BackgroundJob
Description
A background_job
Example
{
"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"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Brand
BrandModelOrder
Description
Ordering options for brand list
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by name |
|
|
Descending by name |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
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}
Cart
Description
A cart
Fields
| Field Name | Description |
|---|---|
_cartProductsMeta - CartProductsMeta
|
Use _parentProductsMeta instead |
_parentProductsMeta - CartProductsMeta
|
|
buyer - User
|
|
buyerId - ID
|
|
cartProducts - [CartProduct]
|
Use parentProducts instead |
createdAt - DateTime
|
|
creatorType - String
|
|
drop - Drop
|
|
dropId - ID
|
|
guestId - ID
|
|
id - ID
|
|
isPrivate - Boolean
|
|
ownerId - ID
|
|
parentProducts - [CartProduct]
|
|
Arguments
|
|
repId - ID
|
|
seller - User
|
|
sellerId - ID
|
|
updatedAt - DateTime
|
|
urlkey - String
|
|
Example
{
"_cartProductsMeta": CartProductsMeta,
"_parentProductsMeta": CartProductsMeta,
"buyer": User,
"buyerId": "4",
"cartProducts": [CartProduct],
"createdAt": "2007-12-03T10:15:30Z",
"creatorType": "xyz789",
"drop": Drop,
"dropId": "4",
"guestId": "4",
"id": "4",
"isPrivate": false,
"ownerId": "4",
"parentProducts": [CartProduct],
"repId": 4,
"seller": User,
"sellerId": "4",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123"
}
CartFilter
CartInput
CartMeta
Description
Medata data for a list carts query
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 987}
CartModelOrder
Description
Ordering options for cart lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
CartProduct
Description
A product in the cart with quantity
Example
{
"cart": Cart,
"cartId": "4",
"id": "4",
"product": Product,
"productId": 4,
"quantity": 987.65,
"variants": [CartProduct]
}
CartProductInput
CartProductModelOrder
Description
Ordering options for cart product lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by ID |
|
|
Descending by ID |
Example
"ID_ASC"
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": "xyz789",
"discountAmount": 987.65,
"margin": 123.45,
"msrpMultiplier": 987.65,
"parentCount": 123,
"profit": 123.45,
"quantity": 123.45,
"summary": "abc123",
"total": 987.65,
"totalRrp": 987.65
}
ConnectRequest
Description
A request to connect on the platform
Example
{
"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"
}
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
}
ConnectRequestModelOrder
Description
Ordering options for connect request lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by ID |
|
|
Descending by ID |
Example
"ID_ASC"
Contact
Description
contact
Fields
| Field Name | Description |
|---|---|
accessCustomers - [AccessContact]
|
|
accessSuppliers - [AccessContact]
|
|
contactUser - User
|
Contact user |
contactUserId - ID
|
|
currency - String
|
|
customId - String
|
|
defaultSupplier - Int
|
|
discount - Float
|
|
email - String
|
|
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 |
migrateOldId - String
|
|
name - String
|
|
notes - String
|
|
ownerId - ID
|
|
paymentBankCustom - String
|
|
paymentEmail - String
|
|
paymentIbanCustom - String
|
|
paymentMethod - String
|
|
paymentTaxCode - String
|
|
paymentVatCustom - String
|
|
phone - String
|
|
shippingAddress - String
|
|
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
|
|
termOfPayment - String
|
|
type - Int
|
0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member |
urlkey - String
|
Example
{
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 123,
"discount": 987.65,
"email": "abc123",
"id": 4,
"img": ["abc123"],
"invite": true,
"invoiceAddress": "abc123",
"invoiceApartment": "xyz789",
"invoiceCity": "abc123",
"invoiceCompany": "xyz789",
"invoiceCountry": "xyz789",
"invoiceFirstname": "abc123",
"invoiceLastname": "abc123",
"invoicePostalcode": "abc123",
"invoiceRegion": "xyz789",
"isSuperman": false,
"isSuperwoman": false,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "xyz789",
"name": "abc123",
"notes": "xyz789",
"ownerId": 4,
"paymentBankCustom": "abc123",
"paymentEmail": "abc123",
"paymentIbanCustom": "abc123",
"paymentMethod": "abc123",
"paymentTaxCode": "xyz789",
"paymentVatCustom": "abc123",
"phone": "xyz789",
"shippingAddress": "xyz789",
"shippingApartment": "abc123",
"shippingCity": "xyz789",
"shippingCompany": "xyz789",
"shippingCountry": "xyz789",
"shippingFirstname": "xyz789",
"shippingLastname": "abc123",
"shippingPostalcode": "abc123",
"shippingRegion": "xyz789",
"showConnectButton": true,
"showPaymentTaxCode": false,
"status": 987,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "abc123"
}
ContactFilter
Fields
| Input Field | Description |
|---|---|
contactUserId - 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,
"name": StringFilter,
"ownerId": IdFilter,
"query": "xyz789",
"type": IntegerFilter
}
ContactInput
Fields
| Input Field | Description |
|---|---|
contactUserId - ID
|
|
currency - String
|
|
customId - String
|
|
defaultSupplier - Int
|
|
discount - Float
|
|
email - 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 - 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
|
|
shippingAddress - String
|
|
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
|
|
termOfPayment - String
|
|
type - Int
|
0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member |
urlkey - String
|
Example
{
"contactUserId": "4",
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 123,
"discount": 123.45,
"email": "abc123",
"invite": true,
"invoiceAddress": "xyz789",
"invoiceApartment": "xyz789",
"invoiceCity": "abc123",
"invoiceCompany": "xyz789",
"invoiceCountry": "xyz789",
"invoiceFirstname": "xyz789",
"invoiceLastname": "xyz789",
"invoicePostalcode": "abc123",
"invoiceRegion": "xyz789",
"isSuperman": SmartBoolean,
"isSuperwoman": SmartBoolean,
"lastInvite": "2007-12-03T10:15:30Z",
"migrateOldId": "abc123",
"name": "abc123",
"notes": "xyz789",
"paymentBankCustom": "abc123",
"paymentEmail": "abc123",
"paymentIbanCustom": "xyz789",
"paymentMethod": "xyz789",
"paymentTaxCode": "abc123",
"paymentVatCustom": "xyz789",
"phone": "abc123",
"shippingAddress": "xyz789",
"shippingApartment": "abc123",
"shippingCity": "abc123",
"shippingCompany": "abc123",
"shippingCountry": "abc123",
"shippingFirstname": "xyz789",
"shippingLastname": "abc123",
"shippingPostalcode": "abc123",
"shippingRegion": "abc123",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 123,
"termOfPayment": "abc123",
"type": 123,
"urlkey": "xyz789"
}
ContactModelOrder
Description
Ordering options for contact lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by id |
|
|
Descending by id |
|
|
Ascending by name |
|
|
Descending by name |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
ContactPage
Fields
| Field Name | Description |
|---|---|
accessCustomers - [AccessContact]
|
|
accessSuppliers - [AccessContact]
|
|
contactUser - User
|
Contact user |
contactUserId - ID
|
|
currency - String
|
|
customId - String
|
|
defaultSupplier - Int
|
|
discount - Float
|
|
email - String
|
|
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 |
members - [String]
|
|
migrateOldId - String
|
|
name - String
|
|
notes - String
|
|
ownerId - ID
|
|
paymentBankCustom - String
|
|
paymentEmail - String
|
|
paymentIbanCustom - String
|
|
paymentMethod - String
|
|
paymentTaxCode - String
|
|
paymentVatCustom - String
|
|
phone - String
|
|
shippingAddress - String
|
|
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
|
|
termOfPayment - String
|
|
type - Int
|
0 = Customer, 1 = Supplier, 2 = Sales Rep, 3 = Team Member |
urlkey - String
|
Example
{
"accessCustomers": [AccessContact],
"accessSuppliers": [AccessContact],
"contactUser": User,
"contactUserId": 4,
"currency": "abc123",
"customId": "abc123",
"defaultSupplier": 123,
"discount": 123.45,
"email": "xyz789",
"group": 987,
"id": "4",
"img": ["xyz789"],
"invite": true,
"invoiceAddress": "abc123",
"invoiceApartment": "abc123",
"invoiceCity": "xyz789",
"invoiceCompany": "xyz789",
"invoiceCountry": "xyz789",
"invoiceFirstname": "abc123",
"invoiceLastname": "abc123",
"invoicePostalcode": "xyz789",
"invoiceRegion": "abc123",
"isSuperman": true,
"isSuperwoman": true,
"lastInvite": "2007-12-03T10:15:30Z",
"members": ["abc123"],
"migrateOldId": "abc123",
"name": "abc123",
"notes": "abc123",
"ownerId": "4",
"paymentBankCustom": "abc123",
"paymentEmail": "xyz789",
"paymentIbanCustom": "xyz789",
"paymentMethod": "xyz789",
"paymentTaxCode": "xyz789",
"paymentVatCustom": "xyz789",
"phone": "abc123",
"shippingAddress": "xyz789",
"shippingApartment": "xyz789",
"shippingCity": "abc123",
"shippingCompany": "xyz789",
"shippingCountry": "abc123",
"shippingFirstname": "abc123",
"shippingLastname": "abc123",
"shippingPostalcode": "abc123",
"shippingRegion": "xyz789",
"showConnectButton": false,
"showPaymentTaxCode": false,
"status": 987,
"termOfPayment": "xyz789",
"type": 987,
"urlkey": "xyz789"
}
ContactsMeta
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"
}
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"}
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 |
fixedAmountValue - Float
|
|
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
|
|
xgetyItems - String
|
|
xgetyMinimumAmount - Float
|
|
xgetyMinimumQtyItems - Float
|
|
xgetyPercentage - Float
|
Example
{
"active": false,
"applications": 123,
"fixedAmountValue": 987.65,
"name": "xyz789",
"ownerId": 4,
"percentageValue": 123.45,
"quantityOrAmount": 123,
"status": false,
"type": 987,
"xgetyItems": "xyz789",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 123.45,
"xgetyPercentage": 123.45
}
CreatePricelistAccessInput
CreatePricelistInput
Fields
| Input Field | Description |
|---|---|
access - [PricelistAccessInput]
|
|
currency - String
|
3 character currency code. eg. USD, EUR, NOK ... |
dropId - ID
|
|
name - String
|
|
ownerId - ID
|
|
status - Boolean
|
Indicates whether pricelist is enabled or disabled 0 enabled, 1 disabled |
type - Int
|
Indicates whether pricelist applies to customer currency (0) selected customers (1) |
values - [UpdatePricelistValueInput]
|
Example
{
"access": [PricelistAccessInput],
"currency": "xyz789",
"dropId": 4,
"name": "abc123",
"ownerId": "4",
"status": true,
"type": 987,
"values": [UpdatePricelistValueInput]
}
CreatePricelistValueInput
Cred
Credential
Description
credential
Fields
| Field Name | Description |
|---|---|
accountType - AccountType
|
|
email - String
|
Email address used for logging in to the platform |
isAdmin - Boolean
|
Indicates whether the credential holder is an admin or not |
nlAccept - Boolean
|
Has the customer subscribed to the Newsletter or not |
plan - Plan
|
Current selected account plan of the seller |
recovery - String
|
To be removed without replacement |
recoveryInform - Boolean
|
|
representing - [User]
|
|
status - Boolean
|
Indicates whether account is active or disabled |
userId - ID
|
|
welcome - Boolean
|
Has an welcome to the platform email been sent or not |
Example
{
"accountType": "BUYER",
"email": "abc123",
"isAdmin": true,
"nlAccept": true,
"plan": Plan,
"recovery": "abc123",
"recoveryInform": false,
"representing": [User],
"status": false,
"userId": 4,
"welcome": true
}
Date
Description
The Date scalar type represents a date
Example
"2007-12-03"
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"
DatetimeFilter
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
|
Not yet used |
id - ID
|
|
name - String
|
Descriptive name of the discount |
ownerId - ID
|
|
percentageValue - Float
|
Discount value in % from the order amount |
quantityOrAmount - Int
|
Not yet used |
status - Boolean
|
Indicates whether discount is activated or not Use active instead! |
type - Int
|
Not yet used |
urlkey - ID
|
Uniq non integer identifier of the discount |
xgetyItems - String
|
Not yet used |
xgetyMinimumAmount - Float
|
Not yet used |
xgetyMinimumQtyItems - Float
|
Not yet used |
xgetyPercentage - Float
|
Not yet used |
Example
{
"active": false,
"applications": 987,
"fixedAmountValue": 123.45,
"id": 4,
"name": "xyz789",
"ownerId": 4,
"percentageValue": 123.45,
"quantityOrAmount": 987,
"status": false,
"type": 123,
"urlkey": "4",
"xgetyItems": "xyz789",
"xgetyMinimumAmount": 987.65,
"xgetyMinimumQtyItems": 987.65,
"xgetyPercentage": 987.65
}
DiscountFilter
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 |
fixedAmountValue - Float
|
|
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": true,
"applications": 987,
"fixedAmountValue": 987.65,
"name": "xyz789",
"ownerId": "4",
"percentageValue": 123.45,
"quantityOrAmount": 123,
"status": true,
"type": 987,
"urlkey": "4",
"xgetyItems": "xyz789",
"xgetyMinimumAmount": 123.45,
"xgetyMinimumQtyItems": 987.65,
"xgetyPercentage": 123.45
}
DiscountModelOrder
Description
Ordering options for discount lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by name |
|
|
Descending by name |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
DiscountsMeta
Description
Meta data for a list of discounts
Fields
| Field Name | Description |
|---|---|
count - Int
|
Number of discounts |
Example
{"count": 123}
Drop
Fields
| Field Name | Description |
|---|---|
_dropProductsMeta - ProductsMeta
|
Drop products metadata |
Arguments
|
|
_products - ProductsMeta
|
Drop product metadata Use _dropProductsMeta instead |
access - Int
|
Field has never been used |
archive - Boolean
|
Use Drop status value 2 for archiving |
asset - String
|
Use assets |
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
|
|
currencySell - 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 |
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
|
|
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
|
Use images |
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 Will be removed without replacement |
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 |
products - [Product]
|
List of products added to the drop Use dropProducts instead |
Arguments
|
|
public - Boolean
|
Please use isPublic instead |
publicVisitorCount - Int
|
Statistical data for drop views Will be removed without replacement |
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
|
|
status - Int
|
0: Not active, 1: Active, 2: Archived |
supplier - Contact
|
Product supplier for drop |
supplierName - String
|
Use name on Supplier |
updatedAt - DateTime
|
|
urlkey - String
|
Unique non sequential identifier for the drop. |
Example
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 987,
"archive": true,
"asset": "abc123",
"assets": ["xyz789"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "abc123",
"currencyBuy": "xyz789",
"currencySell": "xyz789",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": false,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": false,
"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": "abc123",
"openrate": 987,
"order": 987,
"orderItemsQty": 987.65,
"orderQty": 987,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "xyz789",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "abc123",
"products": [Product],
"public": false,
"publicVisitorCount": 123,
"rangeDropInt": "xyz789",
"rangeDropText": "abc123",
"season": "abc123",
"status": 123,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
DropDiscount
Description
Connection between drop and discount
Example
{
"discount": Discount,
"drop": Drop,
"id": "4"
}
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
}
DropInput
Fields
| Input Field | Description |
|---|---|
access - Int
|
|
archive - Boolean
|
|
assets - [String]
|
|
csvSource - String
|
|
currencyBuy - String
|
|
currencySell - 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
|
|
openrate - Int
|
Statistical data for drop views |
order - Int
|
Custom order of the drop in a list view |
orderItemsQty - Float
|
|
orderQty - Int
|
|
orderTotal - Float
|
|
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
|
|
status - Int
|
0: Not active, 1: Active, 2: Archived |
supplierId - ID
|
|
supplierName - String
|
Example
{
"access": 123,
"archive": false,
"assets": ["abc123"],
"csvSource": "abc123",
"currencyBuy": "abc123",
"currencySell": "abc123",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": SmartBoolean,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discoverable": true,
"filter": 987,
"filters": [987],
"images": ["xyz789"],
"info": "abc123",
"isPublic": true,
"name": "abc123",
"note": "xyz789",
"openrate": 123,
"order": 123,
"orderItemsQty": 987.65,
"orderQty": 123,
"orderTotal": 987.65,
"publicVisitorCount": 987,
"rangeDropInt": "xyz789",
"rangeDropText": "abc123",
"season": "xyz789",
"status": 987,
"supplierId": "4",
"supplierName": "abc123"
}
DropMeta
Fields
| Field Name | Description |
|---|---|
orderItemsQty - Float
|
|
orderQty - Int
|
|
orderTotal - Float
|
|
orderTotalArray - [OrderTotal]
|
|
productFilters - [DropProductFilter]
|
Example
{
"orderItemsQty": 987.65,
"orderQty": 123,
"orderTotal": 123.45,
"orderTotalArray": [OrderTotal],
"productFilters": [DropProductFilter]
}
DropModelOrder
Description
Ordering options for drop lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by the custom order field |
|
|
Descending by the custom order field |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
DropProduct
Example
{
"dropId": 4,
"id": "4",
"product": Product,
"productId": "4",
"rowOrder": 987
}
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": "abc123",
"options": [DropProductFilterOption]
}
DropProductFilterOption
DropProductModelOrder
Description
Ordering options for drop product lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by the custom order field |
|
|
Descending by the custom order field |
Example
"ID_ASC"
DropRate
DropStatus
Description
Drop status field values and their meaning
Values
| Enum Value | Description |
|---|---|
|
|
Not Active |
|
|
Active |
|
|
Archived |
Example
"INACTIVE"
DropStatusFilter
Description
Object for collecting filter arguments for field drop status
Fields
| Input Field | Description |
|---|---|
eq - DropStatus
|
|
neq - DropStatus
|
Example
{"eq": "INACTIVE", "neq": "INACTIVE"}
DropWithLink
Fields
| Field Name | Description |
|---|---|
_dropProductsMeta - ProductsMeta
|
Drop products metadata |
Arguments
|
|
_products - ProductsMeta
|
Drop product metadata Use _dropProductsMeta instead |
access - Int
|
Field has never been used |
archive - Boolean
|
Use Drop status value 2 for archiving |
asset - String
|
Use assets |
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
|
|
currencySell - 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 |
discoverable - Boolean
|
Indicates if a public drop is indexable and searchable for other users or not. |
dropLink - String
|
Drop deep link or seller profile link. |
dropProducts - [DropProduct]
|
List of products added to the drop and their order |
Arguments
|
|
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
|
Use images |
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 Will be removed without replacement |
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
|
Please use isPublic instead |
publicVisitorCount - Int
|
Statistical data for drop views Will be removed without replacement |
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
|
|
status - Int
|
0: Not active, 1: Active, 2: Archived |
supplier - Contact
|
Product supplier for drop |
supplierName - String
|
Use name on Supplier |
updatedAt - DateTime
|
|
urlkey - String
|
Unique non sequential identifier for the drop. |
Example
{
"_dropProductsMeta": ProductsMeta,
"_products": ProductsMeta,
"access": 987,
"archive": true,
"asset": "xyz789",
"assets": ["abc123"],
"assetsArchiveGeneratedAt": "2007-12-03T10:15:30Z",
"assetsArchiveUrl": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"csvSource": "xyz789",
"currencyBuy": "abc123",
"currencySell": "abc123",
"deadline": "2007-12-03T10:15:30Z",
"deadlineStop": true,
"deliveryEnd": "2007-12-03",
"deliveryStart": "2007-12-03",
"deliveryWindow": "abc123",
"discounts": [Discount],
"discoverable": true,
"dropLink": "xyz789",
"dropProducts": [DropProduct],
"filter": 987,
"filters": [123],
"id": 4,
"images": ["abc123"],
"img": "xyz789",
"info": "xyz789",
"isPublic": true,
"lastPromotion": "2007-12-03T10:15:30Z",
"name": "abc123",
"note": "xyz789",
"openrate": 123,
"order": 123,
"orderItemsQty": 987.65,
"orderQty": 987,
"orderTotal": 987.65,
"orderTotalArray": [OrderTotal],
"owner": User,
"ownerId": "abc123",
"pdfGeneratedAt": "2007-12-03T10:15:30Z",
"pdfUrl": "abc123",
"public": false,
"publicVisitorCount": 987,
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"season": "abc123",
"status": 987,
"supplier": Contact,
"supplierName": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789"
}
DropsMeta
Description
Meta data for a listDrops query
Fields
| Field Name | Description |
|---|---|
count - Int
|
Number of entries returned in a listDrops query |
Example
{"count": 123}
Event
EventFilter
EventInput
EventModelOrder
Description
Ordering options for event lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by the type field |
|
|
Descending by the type field |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
EventsMeta
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 123}
ExternalContact
ExternalContactFilter
Fields
| Input Field | Description |
|---|---|
contactId - IdFilter
|
|
externalSystemId - IdFilter
|
|
externalSystemName - StringFilter
|
|
partnerIntegrationId - IdFilter
|
Example
{
"contactId": IdFilter,
"externalSystemId": IdFilter,
"externalSystemName": StringFilter,
"partnerIntegrationId": IdFilter
}
ExternalContactInput
ExternalOrder
ExternalOrderFilter
Fields
| Input Field | Description |
|---|---|
externalSystemId - IdFilter
|
|
externalSystemName - StringFilter
|
|
orderId - IdFilter
|
|
partnerIntegrationId - IdFilter
|
Example
{
"externalSystemId": IdFilter,
"externalSystemName": StringFilter,
"orderId": IdFilter,
"partnerIntegrationId": IdFilter
}
ExternalOrderInput
ExternalProduct
ExternalProductFilter
Fields
| Input Field | Description |
|---|---|
externalSystemId - IdFilter
|
|
externalSystemName - StringFilter
|
|
partnerIntegrationId - IdFilter
|
|
productId - IdFilter
|
Example
{
"externalSystemId": IdFilter,
"externalSystemName": StringFilter,
"partnerIntegrationId": IdFilter,
"productId": IdFilter
}
ExternalProductInput
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
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
IdFilter
IndustriesMeta
Description
Meta data for a listIndustries query
Fields
| Field Name | Description |
|---|---|
count - Int
|
Number of entries returned in a listIndustries query |
Example
{"count": 987}
Industry
Example
{
"id": 4,
"listBrands": [Brand],
"name": "abc123"
}
IndustryBrandFilter
IndustryFilter
IndustryModelOrder
Description
Ordering options for industry list
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by name |
|
|
Descending by name |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^53 - 1) and 2^53 - 1 since it is represented in JSON as double-precision floating point numbers specified by IEEE 754.
Example
987
IntegerFilter
Integration
IntegrationConfiguration
Description
integration_configuration
Example
{
"id": 4,
"key": "abc123",
"partnerIntegrationId": "4",
"value": "xyz789"
}
IntegrationConfigurationFilter
IntegrationConfigurationInput
IntegrationData
IntegrationDataInput
IntegrationInput
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
KeyValueInput
ListConnectRequestsMeta
Description
Meta data for a list connect requests query
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 123}
ListNotificationsMeta
Description
Metadata of a list notification query
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 123}
LoginOptions
Fields
| Input Field | Description |
|---|---|
countryCode - String
|
Example
{"countryCode": "abc123"}
Notification
Description
A notification
Example
{
"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"
}
NotificationFilter
Fields
| Input Field | Description |
|---|---|
seenAt - DatetimeFilter
|
Example
{"seenAt": DatetimeFilter}
NotificationObject
Description
Subject of the notification
Types
| Union Types |
|---|
Example
ConnectRequest
Option
Order
Description
A order
Fields
| Field Name | Description |
|---|---|
appliedDiscountId - ID
|
|
appliedPricelistId - ID
|
|
buyer - User
|
User account of the buyer. |
buyerId - ID
|
user id of the buyer |
buyerName - String
|
Use name field on buyer |
cancel - Boolean
|
|
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 |
invoiceDate - Date
|
invoice date for the order |
invoiceNo - String
|
|
isSeller - Boolean
|
|
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]
|
|
products - [Product]
|
|
qty - Float
|
|
rangeOrderInt - String
|
|
rangeOrderText - String
|
|
rating - Int
|
Rating of the order by the buyer. |
rep - User
|
User profile of the order sales rep |
repId - ID
|
|
rows - [OrderRow]
|
|
sellerId - ID
|
|
shippingCosts - Float
|
|
status - Boolean
|
Decides if order is visible in the order downloads false = disabled true = enabled |
sumOfProducts - Float
|
|
supplierName - String
|
To be removed without replacement |
totalAmount - Float
|
|
updatedAt - DateTime
|
|
urlkey - String
|
Non sequential unique identifier |
vat - Float
|
Value-added tax |
Example
{
"appliedDiscountId": 4,
"appliedPricelistId": "4",
"buyer": User,
"buyerId": "4",
"buyerName": "xyz789",
"cancel": false,
"comment": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currency": "xyz789",
"customDiscount": "xyz789",
"customId": "xyz789",
"discountAmount": 987.65,
"discountType": "xyz789",
"drop": Drop,
"dropId": 4,
"extraCosts": 987.65,
"id": "4",
"inform": false,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isSeller": true,
"orderExtraCosts": [OrderExtraCost],
"orderMeta": OrderMeta,
"orderTag": "xyz789",
"owner": User,
"ownerId": "4",
"parentProducts": [OrderProduct],
"products": [Product],
"qty": 123.45,
"rangeOrderInt": "xyz789",
"rangeOrderText": "xyz789",
"rating": 987,
"rep": User,
"repId": 4,
"rows": [OrderRow],
"sellerId": "4",
"shippingCosts": 987.65,
"status": true,
"sumOfProducts": 987.65,
"supplierName": "abc123",
"totalAmount": 123.45,
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "xyz789",
"vat": 987.65
}
OrderExtraCost
OrderExtraCostInput
Fields
| Input Field | Description |
|---|---|
amount - Float
|
|
name - OrderExtraCostType
|
|
taxRatio - Float
|
Example
{"amount": 987.65, "name": "SHIPPING_COST_VAT", "taxRatio": 987.65}
OrderExtraCostType
Description
List of order extra cost types
Values
| Enum Value | Description |
|---|---|
|
|
Shipping cost vat |
Example
"SHIPPING_COST_VAT"
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": "xyz789",
"status": "DISABLED",
"toDate": "2007-12-03T10:15:30Z"
}
OrderInput
Fields
| Input Field | Description |
|---|---|
appliedDiscountId - ID
|
|
appliedPricelistId - ID
|
|
buyerEmail - String
|
|
buyerId - ID
|
|
buyerName - String
|
|
cancel - SmartBoolean
|
|
comment - String
|
|
currency - String
|
|
customDiscount - String
|
|
dropId - ID
|
|
dropName - String
|
|
dropSeason - String
|
|
extraCosts - Float
|
|
inform - SmartBoolean
|
|
informAdmin - SmartBoolean
|
|
invoiceDate - Date
|
|
invoiceNo - String
|
|
isPrivate - SmartBoolean
|
|
isSeller - Boolean
|
|
orderTag - Int
|
|
qty - Float
|
|
rangeOrderInt - String
|
|
rangeOrderText - String
|
|
repId - ID
|
|
sellerId - ID
|
|
shippingCosts - Float
|
|
status - SmartBoolean
|
|
supplierName - String
|
|
totalAmount - Float
|
|
vat - String
|
Example
{
"appliedDiscountId": 4,
"appliedPricelistId": 4,
"buyerEmail": "abc123",
"buyerId": 4,
"buyerName": "xyz789",
"cancel": SmartBoolean,
"comment": "xyz789",
"currency": "xyz789",
"customDiscount": "xyz789",
"dropId": 4,
"dropName": "xyz789",
"dropSeason": "xyz789",
"extraCosts": 987.65,
"inform": SmartBoolean,
"informAdmin": SmartBoolean,
"invoiceDate": "2007-12-03",
"invoiceNo": "abc123",
"isPrivate": SmartBoolean,
"isSeller": true,
"orderTag": 123,
"qty": 123.45,
"rangeOrderInt": "abc123",
"rangeOrderText": "xyz789",
"repId": 4,
"sellerId": 4,
"shippingCosts": 123.45,
"status": SmartBoolean,
"supplierName": "abc123",
"totalAmount": 123.45,
"vat": "abc123"
}
OrderMeta
OrderPdfs
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DELIVERY_NOTE"
OrderPricelist
OrderProduct
Description
order product
Fields
| Field Name | Description |
|---|---|
price - Float
|
|
product - Product
|
|
quantity - Float
|
|
variants - [OrderProduct]
|
Example
{
"price": 987.65,
"product": Product,
"quantity": 987.65,
"variants": [OrderProduct]
}
OrderRow
OrderStatistics
Fields
| Field Name | Description |
|---|---|
amountBySupplier - [AmountBySupplier]
|
|
totalAmount - Float
|
|
totalOrderedItems - Float
|
Example
{
"amountBySupplier": [AmountBySupplier],
"totalAmount": 987.65,
"totalOrderedItems": 987.65
}
OrderStatusOption
Description
List of potential values for the Order status field
Values
| Enum Value | Description |
|---|---|
|
|
Order NOT visible in downloads |
|
|
Order visible in downloads |
Example
"DISABLED"
OrderTagOption
Description
List of potential values for the Order orderTag field
Values
| Enum Value | Description |
|---|---|
|
|
New |
|
|
In progress |
|
|
On hoald |
|
|
Complete |
|
|
Guest order |
|
|
Shipped |
|
|
Approved |
Example
"NEW"
OrderTotal
OrderingOptions
Description
Ordering options for order lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
OrdersMeta
Description
orders meta
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 123}
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
|
|
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"
}
PartnerIntegrationFilter
Fields
| Input Field | Description |
|---|---|
type - PartnerIntegrationTypeFilter
|
Filtering options for partner_integration |
Example
{"type": PartnerIntegrationTypeFilter}
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"}
PartnerIntegrationType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMMON"
PartnerIntegrationTypeFilter
Description
partner_integration_type filter
Fields
| Input Field | Description |
|---|---|
eq - PartnerIntegrationType
|
|
in - [PartnerIntegrationType]
|
|
neq - PartnerIntegrationType
|
Example
{"eq": "COMMON", "in": ["COMMON"], "neq": "COMMON"}
PaymentSubscription
Description
payment_subscription
Example
{
"id": "4",
"stripeCustomerId": "abc123",
"stripeProductId": "xyz789",
"stripeSubscriptionId": "abc123",
"stripeSubscriptionStatus": "abc123"
}
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
}
PaymentSubscriptionInput
Description
payment_subscription_input
Example
{
"stripeCustomerId": "xyz789",
"stripeProductId": "abc123",
"stripeSubscriptionId": "abc123",
"stripeSubscriptionStatus": "xyz789"
}
PaymentSubscriptionModelOrder
Description
Ordering options for payment_subscription lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
Plan
PlanChangeRequest
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
}
PlanChangeRequestModelOrder
Description
Ordering options for plan_change_request lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by ID |
|
|
Descending by ID |
Example
"ID_ASC"
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
}
PlanModelOrder
Description
Ordering options for plan lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by name |
|
|
Descending by name |
Example
"ID_ASC"
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}
PresignedPut
Description
Presigned S3 file upload url
Fields
| Field Name | Description |
|---|---|
url - String
|
Example
{"url": "xyz789"}
Pricelist
Description
pricelist
Fields
| Field Name | Description |
|---|---|
_access - _PricelistAccessMeta
|
|
_values - _PricelistValueMeta
|
|
access - [PricelistAccess]
|
|
currency - String
|
3 character currency code. eg. USD, EUR, NOK ... |
drop - Drop
|
|
dropId - ID
|
|
dropName - String
|
|
id - ID
|
|
name - String
|
|
owner - User
|
|
ownerId - ID
|
|
status - Boolean
|
Indicates whether pricelist is enabled or disabled 0 enabled, 1 disabled |
type - Int
|
Indicates whether pricelist applies to customer currency (0) selected customers (1) |
urlkey - String
|
|
values - [PricelistValue]
|
|
Example
{
"_access": _PricelistAccessMeta,
"_values": _PricelistValueMeta,
"access": [PricelistAccess],
"currency": "xyz789",
"drop": Drop,
"dropId": 4,
"dropName": "abc123",
"id": 4,
"name": "abc123",
"owner": User,
"ownerId": 4,
"status": false,
"type": 123,
"urlkey": "xyz789",
"values": [PricelistValue]
}
PricelistAccess
Example
{
"accessType": 123,
"contact": Contact,
"contactId": "4",
"contactUserId": "4",
"drop": Drop,
"dropId": "4",
"id": 4,
"ownerId": 4,
"pricelistId": 4
}
PricelistAccessInput
PricelistFilter
PricelistOrderingOptions
Description
Ordering options for order lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
PricelistValue
Description
pricelist_value
Example
{
"drop": Drop,
"dropId": "4",
"id": "4",
"ownerId": "4",
"price": 987.65,
"priceList": 987.65,
"pricelistId": 4,
"product": Product,
"productId": 4,
"rrp": "abc123",
"rrpList": "abc123"
}
PricelistsMeta
Description
Meta data for a list of pricelists
Fields
| Field Name | Description |
|---|---|
count - Int
|
Number of pricelists |
Example
{"count": 123}
Product
Description
A product
Fields
| Field Name | Description |
|---|---|
color - String
|
Color of the product. |
cost - Float
|
Use cost on variant |
createdAt - DateTime
|
|
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
|
use customId instead |
customIdText - String
|
use customId instead |
ean - String
|
International (European) Article Number of the product Add EAN number via custom fields. |
externalProducts - [ExternalProduct]
|
List of external_products that references this product |
id - ID
|
|
images - [String]
|
|
img - String
|
use images |
info - String
|
Generic product description |
inventoryStock - String
|
Use field on variant |
inventoryStockLimit - String
|
Not in use |
material - String
|
|
name - String
|
Name of product |
optionGroups - [ProductOptionGroup]
|
|
optionValue1 - String
|
Custom variant value for the first configured field Use field on variant |
optionValue2 - String
|
Custom variant value for the second configured field Use field on variant |
optionValue3 - String
|
Custom variant value for the third configured field Use field on variant |
optionValue4 - String
|
Custom variant value for the forth configured field Use field on variant |
optionValue5 - String
|
Custom variant value for the fifth configured field Use field on variant |
origin - String
|
|
owner - User
|
Owner of the product |
ownerId - String
|
User ID of the product owner |
parent - Product
|
Parent product Only variants have a parent |
parentId - ID
|
Only variants have a parent_id |
parentOrChild - String
|
All products are parent and variant children |
price - Float
|
Use price on variant |
rangeProductInt - String
|
use customId instead |
rangeProductText - String
|
use customId instead |
rrp - String
|
Business. Recommended retail price Use rrp on variant |
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. |
supplier - Contact
|
|
supplierId - ID
|
|
supplierName - String
|
Use name on Supplier |
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 |
variants - [Product]
|
Product variants if they exists Use variantsV2 instead |
variantsV2 - [ProductVariant]
|
Returns paginated list of product variants. One or more variant per product. |
Example
{
"color": "abc123",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "xyz789",
"customField3": "xyz789",
"customField4": "xyz789",
"customField5": "xyz789",
"customField6": "abc123",
"customField7": "abc123",
"customField8": "abc123",
"customId": "abc123",
"customIdInt": "abc123",
"customIdText": "xyz789",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["xyz789"],
"img": "xyz789",
"info": "abc123",
"inventoryStock": "abc123",
"inventoryStockLimit": "abc123",
"material": "abc123",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "xyz789",
"optionValue4": "abc123",
"optionValue5": "xyz789",
"origin": "abc123",
"owner": User,
"ownerId": "abc123",
"parent": Product,
"parentId": 4,
"parentOrChild": "abc123",
"price": 987.65,
"rangeProductInt": "abc123",
"rangeProductText": "xyz789",
"rrp": "xyz789",
"sku": "xyz789",
"soldOut": false,
"supplier": Contact,
"supplierId": "4",
"supplierName": "xyz789",
"taric": "abc123",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
ProductFilter
Example
{
"dropId": IdFilter,
"id": IdFilter,
"parentId": IdFilter,
"query": "xyz789",
"supplierId": IdFilter,
"supplierName": StringFilter
}
ProductInput
Fields
| Input Field | Description |
|---|---|
color - String
|
Color of the product. |
cost - Float
|
|
createdAt - DateTime
|
|
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 |
ean - String
|
International (European) Article Number of the product |
images - [String]
|
|
imgUrls - [String]
|
Integration purposes only - accepts any public image URL and will reupload that to our CDN |
info - String
|
Generic product description |
inventoryStock - String
|
|
material - String
|
|
name - String
|
Name of product |
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 |
optionValue4 - String
|
Custom variant value for the forth configured field |
optionValue5 - String
|
Custom variant value for the fifth configured field |
options - [Option]
|
|
origin - String
|
|
ownerId - String
|
User ID of the product owner |
parentId - ID
|
|
parentOrChild - String
|
|
price - Float
|
|
rangeProductInt - String
|
|
rangeProductText - String
|
|
rrp - String
|
Business. Recommended retail price |
sku - String
|
Stock-keeping unit (SKU) is a scannable bar code |
supplierId - ID
|
|
supplierName - String
|
|
taric - String
|
Code designed to show the various rules applying to specific products when imported into the EU |
type - String
|
Example
{
"color": "abc123",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "xyz789",
"customField3": "abc123",
"customField4": "abc123",
"customField5": "xyz789",
"customField6": "abc123",
"customField7": "xyz789",
"customField8": "abc123",
"customId": "abc123",
"ean": "abc123",
"images": ["abc123"],
"imgUrls": ["abc123"],
"info": "abc123",
"inventoryStock": "xyz789",
"material": "xyz789",
"name": "abc123",
"optionValue1": "xyz789",
"optionValue2": "xyz789",
"optionValue3": "xyz789",
"optionValue4": "xyz789",
"optionValue5": "abc123",
"options": [Option],
"origin": "xyz789",
"ownerId": "xyz789",
"parentId": "4",
"parentOrChild": "xyz789",
"price": 123.45,
"rangeProductInt": "xyz789",
"rangeProductText": "xyz789",
"rrp": "abc123",
"sku": "xyz789",
"supplierId": 4,
"supplierName": "abc123",
"taric": "xyz789",
"type": "xyz789"
}
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
|
|
parentId - 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,
"parentId": IdFilter,
"query": "xyz789",
"supplierId": IdFilter,
"supplierName": StringFilter,
"type": StringFilter
}
ProductModelOrder
Description
Ordering options for product lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
ProductOption
ProductOptionGroup
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
name - String
|
|
options - [ProductOption]
|
Example
{
"id": 4,
"name": "xyz789",
"options": [ProductOption]
}
ProductVariant
Description
A product variant
Fields
| Field Name | Description |
|---|---|
color - String
|
Color of the product. |
cost - Float
|
|
createdAt - DateTime
|
|
id - ID
|
|
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 |
optionValue4 - String
|
Custom variant value for the forth configured field |
optionValue5 - String
|
Custom variant value for the fifth configured field |
parent - Product
|
Product details |
parentId - ID
|
|
price - Float
|
|
rowOrder - Int
|
|
rrp - String
|
Business. Recommended retail price |
sku - String
|
Stock-keeping unit (SKU) is a scannable bar code |
updatedAt - DateTime
|
Example
{
"color": "abc123",
"cost": 123.45,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"inventoryStock": "abc123",
"optionValue1": "xyz789",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "xyz789",
"optionValue5": "xyz789",
"parent": Product,
"parentId": "4",
"price": 123.45,
"rowOrder": 987,
"rrp": "abc123",
"sku": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
ProductVariantInput
Fields
| Input Field | Description |
|---|---|
cost - Float
|
|
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 |
optionValue4 - String
|
Custom variant value for the forth configured field |
optionValue5 - String
|
Custom variant value for the fifth configured field |
parentId - ID
|
|
price - Float
|
|
rowOrder - Int
|
|
rrp - String
|
Business. Recommended retail price |
sku - String
|
Stock-keeping unit (SKU) is a scannable bar code |
Example
{
"cost": 123.45,
"inventoryStock": "xyz789",
"optionValue1": "xyz789",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "abc123",
"optionValue5": "xyz789",
"parentId": 4,
"price": 123.45,
"rowOrder": 123,
"rrp": "xyz789",
"sku": "xyz789"
}
ProductVariantUpdateInput
Fields
| Input Field | Description |
|---|---|
cost - Float
|
|
id - ID
|
|
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 |
optionValue4 - String
|
Custom variant value for the forth configured field |
optionValue5 - String
|
Custom variant value for the fifth configured field |
parentId - ID
|
|
price - Float
|
|
rowOrder - Int
|
|
rrp - String
|
Business. Recommended retail price |
sku - String
|
Stock-keeping unit (SKU) is a scannable bar code |
Example
{
"cost": 987.65,
"id": "4",
"inventoryStock": "abc123",
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "xyz789",
"optionValue4": "xyz789",
"optionValue5": "xyz789",
"parentId": 4,
"price": 987.65,
"rowOrder": 123,
"rrp": "abc123",
"sku": "xyz789"
}
ProductsMeta
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 987}
SearchItem
Description
Searchable items
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONTACTS"
Session
Setting
Description
setting
Fields
| Field Name | Description |
|---|---|
addressAddress - String
|
|
addressApartment - String
|
|
addressCity - String
|
|
addressCompany - String
|
|
addressCountry - String
|
|
addressFirstname - String
|
|
addressLastname - String
|
|
addressPostalcode - String
|
|
country - Country
|
|
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
|
|
customHeight - String
|
|
customInventory - Int
|
|
customInvite - String
|
|
customInviteSubject - String
|
|
customOption1Name - String
|
|
customOption1Status - Int
|
|
customOption2Name - String
|
|
customOption2Status - Int
|
|
customOption3Name - String
|
|
customOption3Status - Int
|
|
customOption4Name - String
|
|
customOption4Status - Int
|
|
customOption5Name - String
|
|
customOption5Status - Int
|
|
customPreorder - Int
|
Used in the old app |
customSeperator - Int
|
|
customThankyou - String
|
Used in the old app |
customUpdate - String
|
|
customWidth - String
|
|
fromCsv - Boolean
|
|
fromEmail - String
|
|
fromMessage - String
|
|
fromPdf - Boolean
|
|
fromSubject - String
|
|
industries - [String]
|
|
integrationToken - Token
|
|
integrationTokenId - ID
|
integration token id |
invoiceText - String
|
|
ownerId - ID
|
|
paymentBank - String
|
|
paymentIban - String
|
|
paymentVat - String
|
|
rangeDropInt - String
|
|
rangeDropText - String
|
|
rangeOrderInt - String
|
|
rangeOrderText - String
|
|
rangeProductInt - String
|
|
rangeProductText - String
|
|
rangeSupplierInt - String
|
|
rangeSupplierText - String
|
|
showInDashboard - Boolean
|
Example
{
"addressAddress": "xyz789",
"addressApartment": "xyz789",
"addressCity": "abc123",
"addressCompany": "abc123",
"addressCountry": "abc123",
"addressFirstname": "xyz789",
"addressLastname": "abc123",
"addressPostalcode": "abc123",
"country": Country,
"customAttach": 987,
"customField1Name": "xyz789",
"customField1Status": 123,
"customField2Name": "xyz789",
"customField2Status": 987,
"customField3Name": "abc123",
"customField3Status": 987,
"customField4Name": "xyz789",
"customField4Status": 123,
"customField5Name": "xyz789",
"customField5Status": 123,
"customField6Name": "xyz789",
"customField6Status": 987,
"customField7Name": "xyz789",
"customField7Status": 123,
"customField8Name": "abc123",
"customField8Status": 987,
"customHeight": "abc123",
"customInventory": 123,
"customInvite": "abc123",
"customInviteSubject": "abc123",
"customOption1Name": "xyz789",
"customOption1Status": 987,
"customOption2Name": "abc123",
"customOption2Status": 987,
"customOption3Name": "abc123",
"customOption3Status": 123,
"customOption4Name": "xyz789",
"customOption4Status": 123,
"customOption5Name": "abc123",
"customOption5Status": 123,
"customPreorder": 987,
"customSeperator": 987,
"customThankyou": "abc123",
"customUpdate": "xyz789",
"customWidth": "abc123",
"fromCsv": false,
"fromEmail": "xyz789",
"fromMessage": "abc123",
"fromPdf": true,
"fromSubject": "xyz789",
"industries": ["xyz789"],
"integrationToken": Token,
"integrationTokenId": 4,
"invoiceText": "abc123",
"ownerId": "4",
"paymentBank": "xyz789",
"paymentIban": "abc123",
"paymentVat": "abc123",
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"rangeOrderInt": "abc123",
"rangeOrderText": "abc123",
"rangeProductInt": "abc123",
"rangeProductText": "abc123",
"rangeSupplierInt": "xyz789",
"rangeSupplierText": "abc123",
"showInDashboard": true
}
SettingInput
Fields
| Input Field | Description |
|---|---|
addressAddress - String
|
|
addressApartment - String
|
|
addressCity - String
|
|
addressCompany - String
|
|
addressCountry - String
|
|
addressFirstname - String
|
|
addressLastname - String
|
|
addressPostalcode - String
|
|
country - CountryInput
|
|
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
|
|
customHeight - String
|
|
customInventory - Int
|
|
customInvite - String
|
|
customInviteSubject - String
|
|
customOption1Name - String
|
|
customOption1Status - Int
|
|
customOption2Name - String
|
|
customOption2Status - Int
|
|
customOption3Name - String
|
|
customOption3Status - Int
|
|
customOption4Name - String
|
|
customOption4Status - Int
|
|
customOption5Name - String
|
|
customOption5Status - Int
|
|
customPreorder - Int
|
|
customSeperator - Int
|
|
customUpdate - String
|
|
customWidth - String
|
|
fromCsv - SmartBoolean
|
|
fromEmail - String
|
|
fromMessage - String
|
|
fromPdf - SmartBoolean
|
|
fromSubject - String
|
|
industries - [String]
|
|
integrationTokenId - ID
|
integration token id |
invoiceText - String
|
|
ownerId - ID
|
|
paymentBank - String
|
|
paymentIban - String
|
|
paymentVat - String
|
|
rangeDropInt - String
|
|
rangeDropText - String
|
|
rangeOrderInt - String
|
|
rangeOrderText - String
|
|
rangeProductInt - String
|
|
rangeProductText - String
|
|
rangeSupplierInt - String
|
|
rangeSupplierText - String
|
|
showInDashboard - SmartBoolean
|
Example
{
"addressAddress": "xyz789",
"addressApartment": "abc123",
"addressCity": "xyz789",
"addressCompany": "abc123",
"addressCountry": "xyz789",
"addressFirstname": "xyz789",
"addressLastname": "xyz789",
"addressPostalcode": "xyz789",
"country": CountryInput,
"customAttach": 987,
"customField1Name": "xyz789",
"customField1Status": 987,
"customField2Name": "xyz789",
"customField2Status": 987,
"customField3Name": "xyz789",
"customField3Status": 987,
"customField4Name": "xyz789",
"customField4Status": 987,
"customField5Name": "abc123",
"customField5Status": 123,
"customField6Name": "abc123",
"customField6Status": 987,
"customField7Name": "xyz789",
"customField7Status": 987,
"customField8Name": "xyz789",
"customField8Status": 987,
"customHeight": "xyz789",
"customInventory": 123,
"customInvite": "xyz789",
"customInviteSubject": "xyz789",
"customOption1Name": "xyz789",
"customOption1Status": 987,
"customOption2Name": "abc123",
"customOption2Status": 987,
"customOption3Name": "xyz789",
"customOption3Status": 123,
"customOption4Name": "abc123",
"customOption4Status": 123,
"customOption5Name": "xyz789",
"customOption5Status": 987,
"customPreorder": 987,
"customSeperator": 987,
"customUpdate": "abc123",
"customWidth": "abc123",
"fromCsv": SmartBoolean,
"fromEmail": "abc123",
"fromMessage": "xyz789",
"fromPdf": SmartBoolean,
"fromSubject": "xyz789",
"industries": ["abc123"],
"integrationTokenId": "4",
"invoiceText": "abc123",
"ownerId": "4",
"paymentBank": "xyz789",
"paymentIban": "xyz789",
"paymentVat": "abc123",
"rangeDropInt": "abc123",
"rangeDropText": "xyz789",
"rangeOrderInt": "abc123",
"rangeOrderText": "xyz789",
"rangeProductInt": "abc123",
"rangeProductText": "xyz789",
"rangeSupplierInt": "abc123",
"rangeSupplierText": "abc123",
"showInDashboard": SmartBoolean
}
SignupConfirmInput
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"
}
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
|
|
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": true,
"acceptTerms": false,
"accountType": "BUYER",
"email": "xyz789",
"inviter": "xyz789",
"name": "abc123",
"password": "xyz789"
}
SmartBoolean
Description
The SmartBoolean scalar type represents a boolean. And is capable of interpretting 1 and 0 representations of Boolean.
Example
SmartBoolean
SpreadsheetType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CSV"
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"
StringFilter
TeamRoleType
Description
List of team roles
Values
| Enum Value | Description |
|---|---|
|
|
Admin |
|
|
Sales Representative |
Example
"ADMIN"
TeamUser
TeamUserModelOrder
Description
Ordering options for drop lists
Values
| Enum Value | Description |
|---|---|
|
|
Ascending by created_at |
|
|
Descending by created_at |
|
|
Ascending by ID |
|
|
Descending by ID |
|
|
Ascending by updated_at |
|
|
Descending by updated_at |
Example
"CREATED_AT_ASC"
TeamUsersMeta
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 987}
Token
UpdatePricelistValueInput
UpdateProductInput
Fields
| Input Field | Description |
|---|---|
cost - Float
|
|
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 |
ean - String
|
International (European) Article Number of the product |
images - [String]
|
|
imgUrls - [String]
|
Integration purposes only - accepts any public image URL and will reupload that to our CDN |
info - String
|
Generic product description |
inventoryStock - String
|
|
material - String
|
|
name - String
|
Name of product |
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 |
optionValue4 - String
|
Custom variant value for the forth configured field |
optionValue5 - String
|
Custom variant value for the fifth configured field |
origin - String
|
|
parentId - ID
|
|
parentOrChild - String
|
|
price - Float
|
|
rrp - String
|
Business. Recommended retail price |
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
{
"cost": 123.45,
"customField1": "xyz789",
"customField2": "abc123",
"customField3": "xyz789",
"customField4": "xyz789",
"customField5": "abc123",
"customField6": "xyz789",
"customField7": "abc123",
"customField8": "abc123",
"ean": "abc123",
"images": ["abc123"],
"imgUrls": ["abc123"],
"info": "xyz789",
"inventoryStock": "abc123",
"material": "abc123",
"name": "abc123",
"optionValue1": "abc123",
"optionValue2": "xyz789",
"optionValue3": "abc123",
"optionValue4": "abc123",
"optionValue5": "abc123",
"origin": "xyz789",
"parentId": "4",
"parentOrChild": "xyz789",
"price": 123.45,
"rrp": "abc123",
"sku": "xyz789",
"supplierId": "4",
"taric": "xyz789",
"type": "abc123"
}
Url
Fields
| Field Name | Description |
|---|---|
url - String
|
Example
{"url": "xyz789"}
UrlkeyFilter
User
Description
Object representing a platform user
Fields
| Field Name | Description |
|---|---|
canSearch - Boolean
|
|
contacts - [Contact]
|
|
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]
|
use image instead |
img - [String]
|
use image instead |
imgMood - [String]
|
use image_mood instead |
info - String
|
|
instagram - String
|
|
name - String
|
|
phone - String
|
|
plans - [UserPlan]
|
Account subscription plan |
setting - Setting
|
User account configuration options |
twitter - String
|
|
url - String
|
|
urlName - String
|
|
urlkey - String
|
|
Example
{
"canSearch": true,
"contacts": [Contact],
"discoverable": false,
"displayName": "abc123",
"emailProfile": "xyz789",
"facebook": "xyz789",
"id": 4,
"image": "xyz789",
"imageMood": "abc123",
"images": ["abc123"],
"img": ["xyz789"],
"imgMood": ["xyz789"],
"info": "abc123",
"instagram": "abc123",
"name": "abc123",
"phone": "xyz789",
"plans": [UserPlan],
"setting": Setting,
"twitter": "abc123",
"url": "abc123",
"urlName": "abc123",
"urlkey": "abc123"
}
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
|
|
images - [String]
|
|
img - [String]
|
|
imgMood - [String]
|
|
info - String
|
|
instagram - String
|
|
name - String
|
|
phone - String
|
|
twitter - String
|
|
url - String
|
|
urlName - String
|
|
urlkey - String
|
Example
{
"canSearch": false,
"discoverable": false,
"displayName": "xyz789",
"emailProfile": "xyz789",
"facebook": "xyz789",
"image": "xyz789",
"imageMood": "abc123",
"images": ["xyz789"],
"img": ["abc123"],
"imgMood": ["abc123"],
"info": "xyz789",
"instagram": "abc123",
"name": "abc123",
"phone": "abc123",
"twitter": "abc123",
"url": "abc123",
"urlName": "xyz789",
"urlkey": "xyz789"
}
UserPlan
Description
User and subscription plan connection
Example
{
"id": 4,
"name": "abc123",
"plan": Plan,
"stripeProductId": "abc123",
"stripeSubscriptionId": "abc123",
"user": User
}
UserProduct
Fields
| Field Name | Description |
|---|---|
color - String
|
Color of the product. |
cost - Float
|
Use cost on variant |
createdAt - DateTime
|
|
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
|
use customId instead |
customIdText - String
|
use customId instead |
ean - String
|
International (European) Article Number of the product Add EAN number via custom fields. |
externalProducts - [ExternalProduct]
|
List of external_products that references this product |
id - ID
|
|
images - [String]
|
|
img - [String]
|
|
info - String
|
Generic product description |
inventoryStock - String
|
Use field on variant |
inventoryStockLimit - String
|
Not in use |
material - String
|
|
name - String
|
Name of product |
optionGroups - [ProductOptionGroup]
|
|
optionValue1 - String
|
Custom variant value for the first configured field Use field on variant |
optionValue2 - String
|
Custom variant value for the second configured field Use field on variant |
optionValue3 - String
|
Custom variant value for the third configured field Use field on variant |
optionValue4 - String
|
Custom variant value for the forth configured field Use field on variant |
optionValue5 - String
|
Custom variant value for the fifth configured field Use field on variant |
origin - String
|
|
owner - User
|
Owner of the product |
ownerId - String
|
User ID of the product owner |
parent - Product
|
Parent product Only variants have a parent |
parentId - ID
|
Only variants have a parent_id |
parentOrChild - String
|
All products are parent and variant children |
price - Float
|
Use price on variant |
rangeProductInt - String
|
use customId instead |
rangeProductText - String
|
use customId instead |
rrp - String
|
Business. Recommended retail price Use rrp on variant |
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. |
supplier - Contact
|
|
supplierId - ID
|
|
supplierName - String
|
Use name on Supplier |
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 |
variants - [Product]
|
Product variants if they exists Use variantsV2 instead |
variantsV2 - [ProductVariant]
|
Returns paginated list of product variants. One or more variant per product. |
Example
{
"color": "xyz789",
"cost": 987.65,
"createdAt": "2007-12-03T10:15:30Z",
"customField1": "abc123",
"customField2": "xyz789",
"customField3": "abc123",
"customField4": "xyz789",
"customField5": "abc123",
"customField6": "xyz789",
"customField7": "abc123",
"customField8": "abc123",
"customId": "xyz789",
"customIdInt": "abc123",
"customIdText": "abc123",
"ean": "abc123",
"externalProducts": [ExternalProduct],
"id": 4,
"images": ["abc123"],
"img": ["abc123"],
"info": "abc123",
"inventoryStock": "xyz789",
"inventoryStockLimit": "xyz789",
"material": "xyz789",
"name": "xyz789",
"optionGroups": [ProductOptionGroup],
"optionValue1": "abc123",
"optionValue2": "abc123",
"optionValue3": "abc123",
"optionValue4": "xyz789",
"optionValue5": "abc123",
"origin": "abc123",
"owner": User,
"ownerId": "xyz789",
"parent": Product,
"parentId": 4,
"parentOrChild": "abc123",
"price": 987.65,
"rangeProductInt": "abc123",
"rangeProductText": "abc123",
"rrp": "abc123",
"sku": "abc123",
"soldOut": false,
"supplier": Contact,
"supplierId": 4,
"supplierName": "xyz789",
"taric": "xyz789",
"type": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"urlkey": "abc123",
"variants": [Product],
"variantsV2": [ProductVariant]
}
Webhook
Description
A webhook
Example
{
"headers": Json,
"id": "4",
"owner": User,
"ownerId": "4",
"password": "abc123",
"url": "xyz789",
"userName": "abc123",
"webhookEvents": [WebhookEvent]
}
WebhookEvent
WebhookEventInput
WebhookInput
Fields
| Input Field | Description |
|---|---|
headers - Json
|
|
password - String
|
|
url - String
|
|
userName - String
|
|
webhookEvents - [WebhookEventInput]
|
Example
{
"headers": Json,
"password": "abc123",
"url": "xyz789",
"userName": "xyz789",
"webhookEvents": [WebhookEventInput]
}
_PricelistAccessMeta
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 123}
_PricelistValueMeta
Fields
| Field Name | Description |
|---|---|
count - Int
|
Example
{"count": 123}