Lead Commerce API API Reference
Welcome to the Lead Commerce API.
In the left navigation under "Operations", you will find instructions for every API endpoint that Lead Commerce offers to developers. Go to the section entitled Authentication to get started.
Below "Schema Definitions", you will find a detailed list of all parameters and return types.
API Endpoints
Production Server:
http://app.leadcommerce.com:8080/graphiql
Authentication
Instructions for authentication will go here.
Requesting an API Token
Will have a Link here to the settings page for API tokens in the app, and instructions on how to form a request.
Accounts
The queries for managing your Account.
Fetch Account
Fetches your account details.
The numerical ID of the account.
Example
Request Content-Types:
application/json
Query
query account($id: Int!){
account(id: $id){
id
name
domain
}
}
Variables
{
"id": "integer"
}
query account($id: Int!){
account(id: $id){
id
name
domain
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"account": {
"id": "integer",
"name": "string",
"domain": "string"
}
}
}
File Upload
The queries for managing your Files.
Fetch Files
Fetches your files.
Example
Request Content-Types:
application/json
Try it now
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"files": [
{
"id": "integer",
"name": "string",
"type": "string",
"size": "integer",
"path": "string",
"signedUrl": "string"
}
]
}
}
Upload Files
Uploads a new file.
(no description)
Example
Request Content-Types:
application/json
Query
mutation uploadFiles($files: [FileUpload]!){
uploadFiles(files: $files)
}
Variables
{
"files": [
null
]
}
mutation uploadFiles($files: [FileUpload]!){
uploadFiles(files: $files)
}
{
"files": [
null
]
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"uploadFiles": [
{
"id": "integer",
"name": "string",
"type": "string",
"size": "integer",
"path": "string",
"signedUrl": "string"
}
]
}
}
Delete Files
Deletes a file.
(no description)
Example
Request Content-Types:
application/json
Query
mutation removeFile($id: Int!){
removeFile(id: $id)
}
Variables
{
"id": "integer"
}
mutation removeFile($id: Int!){
removeFile(id: $id)
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"removeFile": "boolean"
}
}
Users
The queries and mutations for managing your Users.
Fetch Users
Fetches a list of users based on filter criteria.
The input object containing variables to order your user query. Click here for more information.
The input object containing variables to filter your user query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query users($orderBy: OrderByUserInput, $filter: FilterUserInput, $limit: Int, $offset: Int){
users(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
username
isActive
email
hasTakenTour
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"roles": [
"string"
],
"labelIds": [
"number"
],
"isActive": "boolean",
"isInactive": "boolean",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query users($orderBy: OrderByUserInput, $filter: FilterUserInput, $limit: Int, $offset: Int){
users(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
username
isActive
email
hasTakenTour
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"roles": [
"string"
],
"labelIds": [
"number"
],
"isActive": "boolean",
"isInactive": "boolean",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"users": [
{
"id": "integer",
"accountId": "integer",
"username": "string",
"isActive": "boolean",
"email": "string",
"hasTakenTour": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch User
Fetches a user by id.
The numerical ID of the user.
Example
Request Content-Types:
application/json
Query
query user($id: Int!){
user(id: $id){
id
accountId
username
isActive
email
hasTakenTour
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query user($id: Int!){
user(id: $id){
id
accountId
username
isActive
email
hasTakenTour
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"user": {
"id": "integer",
"accountId": "integer",
"username": "string",
"isActive": "boolean",
"email": "string",
"hasTakenTour": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Fetch Current User
Fetches the user currently logged in.
Example
Request Content-Types:
application/json
Try it now
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"currentUser": {
"id": "integer",
"accountId": "integer",
"username": "string",
"isActive": "boolean",
"email": "string",
"hasTakenTour": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create User
Creates a new user.
The input object containing user fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createUser($input: CreateUserInput!){
createUser(input: $input){
}
}
Variables
{
"input": {
"username": "string",
"email": "string",
"password": "string",
"roleSlug": "string",
"isActive": "boolean",
"profile": {
"firstName": "string",
"lastName": "string"
},
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
mutation createUser($input: CreateUserInput!){
createUser(input: $input){
}
}
{
"input": {
"username": "string",
"email": "string",
"password": "string",
"roleSlug": "string",
"isActive": "boolean",
"profile": {
"firstName": "string",
"lastName": "string"
},
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createUser": {}
}
}
Update User
Updates a user record.
The input object containing user fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateUser($input: UpdateUserInput!){
updateUser(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"hasTakenTour": "boolean",
"username": "string",
"roleSlug": "string",
"isActive": "boolean",
"email": "string",
"password": "string",
"profile": {
"firstName": "string",
"lastName": "string"
},
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
mutation updateUser($input: UpdateUserInput!){
updateUser(input: $input){
}
}
{
"input": {
"id": "number",
"hasTakenTour": "boolean",
"username": "string",
"roleSlug": "string",
"isActive": "boolean",
"email": "string",
"password": "string",
"profile": {
"firstName": "string",
"lastName": "string"
},
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateUser": {}
}
}
Delete User
Delete a user record.
The numerical ID of the user.
Example
Request Content-Types:
application/json
Query
mutation deleteUser($id: Int!){
deleteUser(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteUser($id: Int!){
deleteUser(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteUser": {}
}
}
User Roles
The queries and mutations for managing your User Roles.
Fetch User Roles
Fetches a list of user roles based on filter criteria.
The input object containing variables to order your user role query. Click here for more information.
The input object containing variables to filter your user role query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query userRoles($orderBy: OrderByUserRoleInput, $filter: FilterUserRoleInput, $limit: Int, $offset: Int){
userRoles(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
slug
displayName
isActive
routeBlacklist
scopeBlacklist
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"searchText": "string"
},
"limit": "integer",
"offset": "integer"
}
query userRoles($orderBy: OrderByUserRoleInput, $filter: FilterUserRoleInput, $limit: Int, $offset: Int){
userRoles(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
slug
displayName
isActive
routeBlacklist
scopeBlacklist
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"searchText": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRoles": [
{
"id": "integer",
"slug": "string",
"displayName": "string",
"isActive": "boolean",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch User Role
Fetches a user role by id.
The numerical ID of the user role.
Example
Request Content-Types:
application/json
Query
query userRole($id: Int){
userRole(id: $id){
id
slug
displayName
isActive
routeBlacklist
scopeBlacklist
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query userRole($id: Int){
userRole(id: $id){
id
slug
displayName
isActive
routeBlacklist
scopeBlacklist
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"userRole": {
"id": "integer",
"slug": "string",
"displayName": "string",
"isActive": "boolean",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
}
}
Fetch Auth Modules
Fetches a list of auth modules.
Example
Request Content-Types:
application/json
Try it now
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"authModules": [
{
"id": "string",
"name": "string",
"table": "string",
"allScopes": [
"string"
]
}
]
}
}
Create User Role
Creates a new user role.
The input object containing user role fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createUserRole($input: CreateUserRoleInput!){
createUserRole(input: $input){
}
}
Variables
{
"input": {
"displayName": "string",
"slug": "string",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
]
}
}
mutation createUserRole($input: CreateUserRoleInput!){
createUserRole(input: $input){
}
}
{
"input": {
"displayName": "string",
"slug": "string",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createUserRole": {}
}
}
Update User Role
Updates a user role record.
The input object containing user role fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateUserRole($input: UpdateUserRoleInput!){
updateUserRole(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"displayName": "string",
"slug": "string",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
]
}
}
mutation updateUserRole($input: UpdateUserRoleInput!){
updateUserRole(input: $input){
}
}
{
"input": {
"id": "number",
"displayName": "string",
"slug": "string",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateUserRole": {}
}
}
Delete User Role
Deletes a user role record.
The numerical ID of the user role.
Example
Request Content-Types:
application/json
Query
mutation deleteUserRole($id: Int!){
deleteUserRole(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteUserRole($id: Int!){
deleteUserRole(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteUserRole": {}
}
}
Customers
The queries and mutations for managing your Customers.
Fetch Customers
Fetches a list of customers based on filter criteria.
The input object containing variables to order your customer query. Click here for more information.
The input object containing variables to filter your customer query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query customers($orderBy: OrderByCustomerInput, $filter: FilterCustomerInput, $limit: Int, $offset: Int){
customers(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
businessName
amountDue
amountPaid
total
stripeId
quickBooksId
quickBooksSyncToken
termId
taxExempt
taxRate
notes
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query customers($orderBy: OrderByCustomerInput, $filter: FilterCustomerInput, $limit: Int, $offset: Int){
customers(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
businessName
amountDue
amountPaid
total
stripeId
quickBooksId
quickBooksSyncToken
termId
taxExempt
taxRate
notes
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"customers": [
{
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"businessName": "string",
"amountDue": "number",
"amountPaid": "number",
"total": "number",
"stripeId": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string",
"termId": "integer",
"taxExempt": "boolean",
"taxRate": "number",
"notes": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Customer
Fetches a customer by id.
The numerical ID of the customer.
Example
Request Content-Types:
application/json
Query
query customer($id: Int!){
customer(id: $id){
id
displayId
accountId
altId
businessName
amountDue
amountPaid
total
stripeId
quickBooksId
quickBooksSyncToken
termId
taxExempt
taxRate
notes
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query customer($id: Int!){
customer(id: $id){
id
displayId
accountId
altId
businessName
amountDue
amountPaid
total
stripeId
quickBooksId
quickBooksSyncToken
termId
taxExempt
taxRate
notes
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"customer": {
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"businessName": "string",
"amountDue": "number",
"amountPaid": "number",
"total": "number",
"stripeId": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string",
"termId": "integer",
"taxExempt": "boolean",
"taxRate": "number",
"notes": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Customer
Creates a new customer.
The input object containing customer fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createCustomer($input: CreateCustomerInput!){
createCustomer(input: $input){
}
}
Variables
{
"input": {
"altId": "string",
"businessName": "string",
"termId": "number",
"taxExempt": "boolean",
"taxRate": "number",
"notes": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
mutation createCustomer($input: CreateCustomerInput!){
createCustomer(input: $input){
}
}
{
"input": {
"altId": "string",
"businessName": "string",
"termId": "number",
"taxExempt": "boolean",
"taxRate": "number",
"notes": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createCustomer": {}
}
}
Update Customer
Updates a customer record.
The input object containing customer fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateCustomer($input: UpdateCustomerInput!){
updateCustomer(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"altId": "string",
"businessName": "string",
"termId": "number",
"taxExempt": "boolean",
"taxRate": "number",
"notes": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
mutation updateCustomer($input: UpdateCustomerInput!){
updateCustomer(input: $input){
}
}
{
"input": {
"id": "number",
"altId": "string",
"businessName": "string",
"termId": "number",
"taxExempt": "boolean",
"taxRate": "number",
"notes": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateCustomer": {}
}
}
Delete Customer
Delete a customer record.
The numerical ID of the customer.
Example
Request Content-Types:
application/json
Query
mutation deleteCustomer($id: Int!){
deleteCustomer(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteCustomer($id: Int!){
deleteCustomer(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteCustomer": {}
}
}
Contacts
The queries and mutations for managing your Contacts.
Create Contact
Creates a new contact.
The input object containing contact fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createContact($input: CreateContactInput!){
createContact(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"phone": "string",
"email": "string"
}
}
mutation createContact($input: CreateContactInput!){
createContact(input: $input){
}
}
{
"input": {
"name": "string",
"phone": "string",
"email": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createContact": {}
}
}
Update Contact
Updates a contact record.
The input object containing contact fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateContact($input: UpdateContactInput!){
updateContact(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"phone": "string",
"email": "string"
}
}
mutation updateContact($input: UpdateContactInput!){
updateContact(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"phone": "string",
"email": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateContact": {}
}
}
Delete Contact
Delete a contact record.
The numerical ID of the address.
Example
Request Content-Types:
application/json
Query
mutation deleteContact($id: Int!){
deleteContact(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteContact($id: Int!){
deleteContact(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteContact": {}
}
}
Addresses
The queries and mutations for managing your Addresses.
Fetch Addresses
Fetches a list of addresses based on filter criteria.
Example
Request Content-Types:
application/json
Try it now
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"addresses": [
{
"id": "integer",
"accountId": "integer",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
]
}
}
Fetch Address
Fetches a address by id.
The numerical ID of the address.
Example
Request Content-Types:
application/json
Query
query address($id: Int!){
address(id: $id){
id
accountId
name
fullAddress
address1
address2
address3
postalCode
city
district
country
}
}
Variables
{
"id": "integer"
}
query address($id: Int!){
address(id: $id){
id
accountId
name
fullAddress
address1
address2
address3
postalCode
city
district
country
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"address": {
"id": "integer",
"accountId": "integer",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
}
}
Create Address
Creates a new address.
The input object containing address fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createAddress($input: CreateAddressInput!){
createAddress(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
}
mutation createAddress($input: CreateAddressInput!){
createAddress(input: $input){
}
}
{
"input": {
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createAddress": {}
}
}
Update Address
Updates a address record.
The input object containing address fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateAddress($input: UpdateAddressInput!){
updateAddress(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
}
mutation updateAddress($input: UpdateAddressInput!){
updateAddress(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateAddress": {}
}
}
Delete Address
Delete a address record.
The numerical ID of the address.
Example
Request Content-Types:
application/json
Query
mutation deleteAddress($id: Int!){
deleteAddress(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteAddress($id: Int!){
deleteAddress(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteAddress": {}
}
}
Vendors
The queries and mutations for managing your Vendors.
Fetch Vendors
Fetches a list of vendors based on filter criteria.
The input object containing variables to order your vendor query. Click here for more information.
The input object containing variables to filter your vendor query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query vendors($orderBy: OrderByVendorInput, $filter: FilterVendorInput, $limit: Int, $offset: Int){
vendors(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
name
quickBooksId
quickBooksSyncToken
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query vendors($orderBy: OrderByVendorInput, $filter: FilterVendorInput, $limit: Int, $offset: Int){
vendors(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
name
quickBooksId
quickBooksSyncToken
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"vendors": [
{
"id": "integer",
"accountId": "integer",
"name": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Vendor
Fetches a vendor by id.
The numerical ID of the vendor.
Example
Request Content-Types:
application/json
Query
query vendor($id: Int!){
vendor(id: $id){
id
accountId
name
quickBooksId
quickBooksSyncToken
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query vendor($id: Int!){
vendor(id: $id){
id
accountId
name
quickBooksId
quickBooksSyncToken
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"vendor": {
"id": "integer",
"accountId": "integer",
"name": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Vendor
Creates a new vendor.
The input object containing vendor fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createVendor($input: CreateVendorInput!){
createVendor(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"skuIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
mutation createVendor($input: CreateVendorInput!){
createVendor(input: $input){
}
}
{
"input": {
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"skuIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createVendor": {}
}
}
Update Vendor
Updates a vendor record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateVendor($input: UpdateVendorInput!){
updateVendor(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"skuIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
mutation updateVendor($input: UpdateVendorInput!){
updateVendor(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"skuIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateVendor": {}
}
}
Delete Vendor
Delete a vendor record.
The numerical ID of the vendor.
Example
Request Content-Types:
application/json
Query
mutation deleteVendor($id: Int!){
deleteVendor(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteVendor($id: Int!){
deleteVendor(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteVendor": {}
}
}
Warehouses
The queries and mutations for managing your Warehouses.
Fetch Warehouses
Fetches a list of warehouses based on filter criteria.
The input object containing variables to order your warehouse query. Click here for more information.
The input object containing variables to filter your warehouse query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query warehouses($orderBy: OrderByWarehouseInput, $filter: FilterWarehouseInput, $limit: Int, $offset: Int){
warehouses(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
name
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query warehouses($orderBy: OrderByWarehouseInput, $filter: FilterWarehouseInput, $limit: Int, $offset: Int){
warehouses(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
name
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"warehouses": [
{
"id": "integer",
"accountId": "integer",
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Warehouse
Fetches a warehouse by id.
The numerical ID of the warehouse.
Example
Request Content-Types:
application/json
Query
query warehouse($id: Int!){
warehouse(id: $id){
id
accountId
name
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query warehouse($id: Int!){
warehouse(id: $id){
id
accountId
name
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"warehouse": {
"id": "integer",
"accountId": "integer",
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Warehouse
Creates a new warehouse.
The input object containing warehouse fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createWarehouse($input: CreateWarehouseInput!){
createWarehouse(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
mutation createWarehouse($input: CreateWarehouseInput!){
createWarehouse(input: $input){
}
}
{
"input": {
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createWarehouse": {}
}
}
Update Warehouse
Updates a warehouse record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateWarehouse($input: UpdateWarehouseInput!){
updateWarehouse(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
mutation updateWarehouse($input: UpdateWarehouseInput!){
updateWarehouse(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateWarehouse": {}
}
}
Delete Warehouse
Delete a warehouse record.
The numerical ID of the warehouse.
Example
Request Content-Types:
application/json
Query
mutation deleteWarehouse($id: Int!){
deleteWarehouse(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteWarehouse($id: Int!){
deleteWarehouse(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteWarehouse": {}
}
}
Bin Locations
The queries and mutations for managing your Bin Locations within your warehouses.
Fetch Bin Locations
Fetches a list of bin locations based on filter criteria.
The input object containing variables to order your bin query. Click here for more information.
The input object containing variables to filter your bin query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query binLocations($orderBy: OrderByBinLocationInput, $filter: FilterBinLocationInput, $limit: Int, $offset: Int){
binLocations(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
warehouseId
name
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query binLocations($orderBy: OrderByBinLocationInput, $filter: FilterBinLocationInput, $limit: Int, $offset: Int){
binLocations(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
warehouseId
name
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"binLocations": [
{
"id": "integer",
"accountId": "integer",
"warehouseId": "integer",
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Bin Location
Fetches a bin location by id.
The numerical ID of the bin location.
Example
Request Content-Types:
application/json
Query
query binLocation($id: Int!){
binLocation(id: $id){
id
accountId
warehouseId
name
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query binLocation($id: Int!){
binLocation(id: $id){
id
accountId
warehouseId
name
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"binLocation": {
"id": "integer",
"accountId": "integer",
"warehouseId": "integer",
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Bin Location
Creates a new bin location.
The input object containing bin location fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createBinLocation($input: CreateBinLocationInput!){
createBinLocation(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"warehouseId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
mutation createBinLocation($input: CreateBinLocationInput!){
createBinLocation(input: $input){
}
}
{
"input": {
"name": "string",
"warehouseId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createBinLocation": {}
}
}
Update Bin Location
Updates a bin location record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateBinLocation($input: UpdateBinLocationInput!){
updateBinLocation(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
mutation updateBinLocation($input: UpdateBinLocationInput!){
updateBinLocation(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateBinLocation": {}
}
}
Delete Bin Location
Delete a bin location record.
The numerical ID of the bin location.
Example
Request Content-Types:
application/json
Query
mutation deleteBinLocation($id: Int!){
deleteBinLocation(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteBinLocation($id: Int!){
deleteBinLocation(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteBinLocation": {}
}
}
Products
The queries and mutations for managing your Products.
Fetch Products
Fetches a list of products based on filter criteria.
The input object containing variables to order your product query. Click here for more information.
The input object containing variables to filter your product query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query products($orderBy: OrderByProductInput, $filter: FilterProductInput, $limit: Int, $offset: Int){
products(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
displayId
name
description
templateId
storeUrl
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query products($orderBy: OrderByProductInput, $filter: FilterProductInput, $limit: Int, $offset: Int){
products(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
displayId
name
description
templateId
storeUrl
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"products": [
{
"id": "integer",
"accountId": "integer",
"displayId": "string",
"name": "string",
"description": "string",
"templateId": "integer",
"storeUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Product
Fetches a product by id.
The numerical ID of the product.
Example
Request Content-Types:
application/json
Query
query product($id: Int!){
product(id: $id){
id
accountId
displayId
name
description
templateId
storeUrl
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query product($id: Int!){
product(id: $id){
id
accountId
displayId
name
description
templateId
storeUrl
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"product": {
"id": "integer",
"accountId": "integer",
"displayId": "string",
"name": "string",
"description": "string",
"templateId": "integer",
"storeUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Product
Creates a new product.
The input object containing product fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createProduct($input: CreateProductInput!){
createProduct(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"displayId": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"description": "string",
"templateId": "number"
}
}
mutation createProduct($input: CreateProductInput!){
createProduct(input: $input){
}
}
{
"input": {
"name": "string",
"displayId": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"description": "string",
"templateId": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createProduct": {}
}
}
Update Product
Updates a product record.
The input object containing product fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateProduct($input: UpdateProductInput!){
updateProduct(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"displayId": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"description": "string",
"templateId": "number"
}
}
mutation updateProduct($input: UpdateProductInput!){
updateProduct(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"displayId": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"description": "string",
"templateId": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateProduct": {}
}
}
Delete Product
Deletes a product record.
The numerical ID of the product.
Example
Request Content-Types:
application/json
Query
mutation deleteProduct($id: Int!){
deleteProduct(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteProduct($id: Int!){
deleteProduct(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteProduct": {}
}
}
Inventory
Fetch SKUs
Fetches a list of skus based on filter criteria.
The input object containing variables to order your sku query. Click here for more information.
The input object containing variables to filter your sku query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
The input object containing variables to filter your sku stock levels subquery. Click here for more information.
The input object containing variables to filter your lot levels subquery. Click here for more information.
The input object containing variables to filter your skus by sku levels. Click here for more information.
Example
Request Content-Types:
application/json
Query
query skus($orderBy: OrderBySKUInput, $filter: FilterSKUInput, $limit: Int, $offset: Int, $stockLevelsFilter: FilterStockLevelsInput, $lotsFilter: FilterLotsInput, $skuLevelsFilter: FilterSKULevelsInput){
skus(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset, stockLevelsFilter: $stockLevelsFilter, lotsFilter: $lotsFilter, skuLevelsFilter: $skuLevelsFilter){
id
isKit
accountId
productId
code
name
minStockLevel
maxStockLevel
createdAt
updatedAt
quickBooksId
quickBooksSyncToken
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"belowMinStockLevel": "boolean",
"searchText": "string",
"labelIds": [
"number"
],
"vendorIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer",
"stockLevelsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
},
"lotsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
},
"skuLevelsFilter": {
"type": "string"
}
}
query skus($orderBy: OrderBySKUInput, $filter: FilterSKUInput, $limit: Int, $offset: Int, $stockLevelsFilter: FilterStockLevelsInput, $lotsFilter: FilterLotsInput, $skuLevelsFilter: FilterSKULevelsInput){
skus(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset, stockLevelsFilter: $stockLevelsFilter, lotsFilter: $lotsFilter, skuLevelsFilter: $skuLevelsFilter){
id
isKit
accountId
productId
code
name
minStockLevel
maxStockLevel
createdAt
updatedAt
quickBooksId
quickBooksSyncToken
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"belowMinStockLevel": "boolean",
"searchText": "string",
"labelIds": [
"number"
],
"vendorIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer",
"stockLevelsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
},
"lotsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
},
"skuLevelsFilter": {
"type": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"skus": [
{
"id": "integer",
"isKit": "boolean",
"accountId": "integer",
"productId": "integer",
"code": "string",
"name": "string",
"minStockLevel": "number",
"maxStockLevel": "number",
"createdAt": "string",
"updatedAt": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string"
}
]
}
}
Fetch SKU
Fetches a sku by id.
The numerical ID of the sku.
The input object containing variables to filter your sku stock levels subquery. Click here for more information.
The input object containing variables to filter your lot levels subquery. Click here for more information.
Example
Request Content-Types:
application/json
Query
query sku($id: Int!, $stockLevelsFilter: FilterStockLevelsInput, $lotsFilter: FilterLotsInput){
sku(id: $id, stockLevelsFilter: $stockLevelsFilter, lotsFilter: $lotsFilter){
id
isKit
accountId
productId
code
name
minStockLevel
maxStockLevel
createdAt
updatedAt
quickBooksId
quickBooksSyncToken
}
}
Variables
{
"id": "integer",
"stockLevelsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
},
"lotsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
}
}
query sku($id: Int!, $stockLevelsFilter: FilterStockLevelsInput, $lotsFilter: FilterLotsInput){
sku(id: $id, stockLevelsFilter: $stockLevelsFilter, lotsFilter: $lotsFilter){
id
isKit
accountId
productId
code
name
minStockLevel
maxStockLevel
createdAt
updatedAt
quickBooksId
quickBooksSyncToken
}
}
{
"id": "integer",
"stockLevelsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
},
"lotsFilter": {
"groupBy": "string",
"idIn": [
"number"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"sku": {
"id": "integer",
"isKit": "boolean",
"accountId": "integer",
"productId": "integer",
"code": "string",
"name": "string",
"minStockLevel": "number",
"maxStockLevel": "number",
"createdAt": "string",
"updatedAt": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string"
}
}
}
Create SKU
Creates a new sku.
The input object containing sku fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createSKU($input: CreateSKUInput!){
createSKU(input: $input){
}
}
Variables
{
"input": {
"isKit": "boolean",
"productId": "number",
"code": "string",
"name": "string",
"cost": "number",
"price": "number",
"vendorId": "number",
"vendorPartNumber": "string",
"vendorIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"files": [
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
],
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"minStockLevel": "number",
"maxStockLevel": "number"
}
}
mutation createSKU($input: CreateSKUInput!){
createSKU(input: $input){
}
}
{
"input": {
"isKit": "boolean",
"productId": "number",
"code": "string",
"name": "string",
"cost": "number",
"price": "number",
"vendorId": "number",
"vendorPartNumber": "string",
"vendorIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"files": [
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
],
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"minStockLevel": "number",
"maxStockLevel": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createSKU": {}
}
}
Update SKU
Updates a sku record.
The input object containing sku fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateSKU($input: UpdateSKUInput!){
updateSKU(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"isKit": "boolean",
"code": "string",
"name": "string",
"productId": "number",
"vendorIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"files": [
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
],
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"minStockLevel": "number",
"maxStockLevel": "number"
}
}
mutation updateSKU($input: UpdateSKUInput!){
updateSKU(input: $input){
}
}
{
"input": {
"id": "number",
"isKit": "boolean",
"code": "string",
"name": "string",
"productId": "number",
"vendorIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"files": [
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
],
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"minStockLevel": "number",
"maxStockLevel": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateSKU": {}
}
}
Delete SKU
Deletes a sku record.
The numerical ID of the sku.
Example
Request Content-Types:
application/json
Query
mutation deleteSKU($id: Int!){
deleteSKU(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteSKU($id: Int!){
deleteSKU(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteSKU": {}
}
}
Fetch Inventory Lots
Fetches a list of lots based on filter criteria.
The input object containing variables to order your lot query. Click here for more information.
The input object containing variables to filter your lot query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query lots($orderBy: OrderByLotInput, $filter: FilterLotInput, $limit: Int, $offset: Int){
lots(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
skuId
skuCode
skuName
binId
binName
name
description
quantity
originalQuantity
quantityAllocated
quantityCommitted
cost
quantityMapped
quantityReceived
lotNumber
altLotNumber
serialNumber
salesOrderId
salesOrderDisplayId
workOrderAssemblyId
workOrderId
workOrderBOMCOGS
manufactureDate
expirationDate
totalValue
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"searchText": "string",
"warehouseIds": [
"number"
],
"skuId": "number",
"skuIds": [
"number"
],
"ids": [
"number"
],
"excludeIds": [
"number"
],
"manufacturedAfter": "object",
"manufacturedBefore": "object",
"expiredAfter": "object",
"expiredBefore": "object",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query lots($orderBy: OrderByLotInput, $filter: FilterLotInput, $limit: Int, $offset: Int){
lots(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
skuId
skuCode
skuName
binId
binName
name
description
quantity
originalQuantity
quantityAllocated
quantityCommitted
cost
quantityMapped
quantityReceived
lotNumber
altLotNumber
serialNumber
salesOrderId
salesOrderDisplayId
workOrderAssemblyId
workOrderId
workOrderBOMCOGS
manufactureDate
expirationDate
totalValue
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"searchText": "string",
"warehouseIds": [
"number"
],
"skuId": "number",
"skuIds": [
"number"
],
"ids": [
"number"
],
"excludeIds": [
"number"
],
"manufacturedAfter": "object",
"manufacturedBefore": "object",
"expiredAfter": "object",
"expiredBefore": "object",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lots": [
{
"id": "integer",
"accountId": "integer",
"skuId": "integer",
"skuCode": "string",
"skuName": "string",
"binId": "integer",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "integer",
"salesOrderDisplayId": "integer",
"workOrderAssemblyId": "integer",
"workOrderId": "integer",
"workOrderBOMCOGS": "number",
"totalValue": "number",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Inventory Lot
Fetches a lot by id.
The numerical ID of the lot.
Example
Request Content-Types:
application/json
Query
query lot($id: Int!){
lot(id: $id){
id
accountId
skuId
skuCode
skuName
binId
binName
name
description
quantity
originalQuantity
quantityAllocated
quantityCommitted
cost
quantityMapped
quantityReceived
lotNumber
altLotNumber
serialNumber
salesOrderId
salesOrderDisplayId
workOrderAssemblyId
workOrderId
workOrderBOMCOGS
manufactureDate
expirationDate
totalValue
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query lot($id: Int!){
lot(id: $id){
id
accountId
skuId
skuCode
skuName
binId
binName
name
description
quantity
originalQuantity
quantityAllocated
quantityCommitted
cost
quantityMapped
quantityReceived
lotNumber
altLotNumber
serialNumber
salesOrderId
salesOrderDisplayId
workOrderAssemblyId
workOrderId
workOrderBOMCOGS
manufactureDate
expirationDate
totalValue
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lot": {
"id": "integer",
"accountId": "integer",
"skuId": "integer",
"skuCode": "string",
"skuName": "string",
"binId": "integer",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "integer",
"salesOrderDisplayId": "integer",
"workOrderAssemblyId": "integer",
"workOrderId": "integer",
"workOrderBOMCOGS": "number",
"totalValue": "number",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Inventory Lot
Creates a new inventory lot.
The input object containing lot fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createLot($input: CreateLotInput!){
createLot(input: $input){
}
}
Variables
{
"input": {
"skuId": "number",
"binId": "number",
"quantity": "number",
"cost": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object"
}
}
mutation createLot($input: CreateLotInput!){
createLot(input: $input){
}
}
{
"input": {
"skuId": "number",
"binId": "number",
"quantity": "number",
"cost": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createLot": {}
}
}
Update Inventory Lot
Updates a lot record.
The input object containing lot fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateLot($input: UpdateLotInput!){
updateLot(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"binId": "number",
"lotNumber": "string",
"cost": "number",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object"
}
}
mutation updateLot($input: UpdateLotInput!){
updateLot(input: $input){
}
}
{
"input": {
"id": "number",
"binId": "number",
"lotNumber": "string",
"cost": "number",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateLot": {}
}
}
Adjust Inventory Lot
Adjusts the quantity on an inventory lot.
The input object containing fields for adjustments. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createAdjustment($input: CreateAdjustmentInput!){
createAdjustment(input: $input){
}
}
Variables
{
"input": {
"lotId": "number",
"skuId": "number",
"binId": "number",
"quantityAdjustment": "number",
"reason": "string"
}
}
mutation createAdjustment($input: CreateAdjustmentInput!){
createAdjustment(input: $input){
}
}
{
"input": {
"lotId": "number",
"skuId": "number",
"binId": "number",
"quantityAdjustment": "number",
"reason": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createAdjustment": {}
}
}
Delete Inventory Lot
Deletes a lot record.
The numerical ID of the lot.
Example
Request Content-Types:
application/json
Query
mutation deleteLot($id: Int!){
deleteLot(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteLot($id: Int!){
deleteLot(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteLot": {}
}
}
Stock History
Fetches stock history for a given SKU.
The numerical ID of the SKU.
The input object containing variables to filter your stock history query. Click here for more information.
(no description)
The number of records you wish to fetch.
The page offset of the records you wish to fetch.
Example
Request Content-Types:
application/json
Query
query stockHistory($skuId: Int!, $filter: FilterStockHistoryInput, $orderBy: OrderByStockHistoryInput, $limit: Int, $offset: Int){
stockHistory(skuId: $skuId, filter: $filter, orderBy: $orderBy, limit: $limit, offset: $offset){
id
skuId
skuName
skuCode
warehouseId
warehouseName
lotId
binId
binName
receivementId
purchaseOrderId
purchaseOrderDisplayId
salesOrderId
salesOrderDisplayId
workOrderId
workOrderDisplayId
transferId
transferDisplayId
quantityAdded
type
createdAt
updatedAt
}
}
Variables
{
"skuId": "integer",
"filter": {
"warehouseIds": [
"number"
],
"type": "string",
"createdAfter": "string",
"createdBefore": "string"
},
"orderBy": {
"column": "string",
"order": "string"
},
"limit": "integer",
"offset": "integer"
}
query stockHistory($skuId: Int!, $filter: FilterStockHistoryInput, $orderBy: OrderByStockHistoryInput, $limit: Int, $offset: Int){
stockHistory(skuId: $skuId, filter: $filter, orderBy: $orderBy, limit: $limit, offset: $offset){
id
skuId
skuName
skuCode
warehouseId
warehouseName
lotId
binId
binName
receivementId
purchaseOrderId
purchaseOrderDisplayId
salesOrderId
salesOrderDisplayId
workOrderId
workOrderDisplayId
transferId
transferDisplayId
quantityAdded
type
createdAt
updatedAt
}
}
{
"skuId": "integer",
"filter": {
"warehouseIds": [
"number"
],
"type": "string",
"createdAfter": "string",
"createdBefore": "string"
},
"orderBy": {
"column": "string",
"order": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"stockHistory": [
{
"id": "integer",
"skuId": "integer",
"skuName": "string",
"skuCode": "string",
"warehouseId": "integer",
"warehouseName": "string",
"lotId": "integer",
"binId": "integer",
"binName": "string",
"receivementId": "integer",
"purchaseOrderId": "integer",
"purchaseOrderDisplayId": "string",
"salesOrderId": "integer",
"salesOrderDisplayId": "string",
"workOrderId": "integer",
"workOrderDisplayId": "string",
"transferId": "integer",
"transferDisplayId": "string",
"quantityAdded": "number",
"type": "string"
}
]
}
}
Cost Rules
The queries and mutations for managing your Cost Rules.
Fetch Cost Rules
Fetches a list of cost rules based on filter criteria.
The input object containing variables to order your cost rule query. Click here for more information.
The input object containing variables to filter your cost rule query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query costRules($orderBy: OrderByCostRuleInput, $filter: FilterCostRuleInput, $limit: Int, $offset: Int){
costRules(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
vendorId
vendorName
vendorPartNumber
skuId
skuName
skuCode
quantity
cost
unit
createdAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"skuIds": [
"number"
],
"vendorIds": [
"number"
],
"quantityGreaterThanOrEqualTo": "number",
"quantityLessThanOrEqualTo": "number",
"quantityEquals": "number",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query costRules($orderBy: OrderByCostRuleInput, $filter: FilterCostRuleInput, $limit: Int, $offset: Int){
costRules(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
vendorId
vendorName
vendorPartNumber
skuId
skuName
skuCode
quantity
cost
unit
createdAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"skuIds": [
"number"
],
"vendorIds": [
"number"
],
"quantityGreaterThanOrEqualTo": "number",
"quantityLessThanOrEqualTo": "number",
"quantityEquals": "number",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"costRules": [
{
"id": "integer",
"accountId": "integer",
"vendorId": "integer",
"vendorName": "string",
"vendorPartNumber": "string",
"skuId": "integer",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"cost": "number",
"unit": "string",
"createdAt": "string"
}
]
}
}
Fetch Cost Rule
Fetches a cost rule by id.
The numerical ID of the cost rule.
Example
Request Content-Types:
application/json
Query
query costRule($id: Int!){
costRule(id: $id){
id
accountId
vendorId
vendorName
vendorPartNumber
skuId
skuName
skuCode
quantity
cost
unit
createdAt
}
}
Variables
{
"id": "integer"
}
query costRule($id: Int!){
costRule(id: $id){
id
accountId
vendorId
vendorName
vendorPartNumber
skuId
skuName
skuCode
quantity
cost
unit
createdAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"costRule": {
"id": "integer",
"accountId": "integer",
"vendorId": "integer",
"vendorName": "string",
"vendorPartNumber": "string",
"skuId": "integer",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"cost": "number",
"unit": "string",
"createdAt": "string"
}
}
}
Create Cost Rule
Creates a new cost rule.
The input object containing cost rule fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createCostRule($input: CreateCostRuleInput!){
createCostRule(input: $input){
}
}
Variables
{
"input": {
"skuId": "number",
"vendorId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"cost": "number"
}
}
mutation createCostRule($input: CreateCostRuleInput!){
createCostRule(input: $input){
}
}
{
"input": {
"skuId": "number",
"vendorId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"cost": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createCostRule": {}
}
}
Update Cost Rule
Updates a cost rule.
The input object containing cost rule fields for update. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateCostRule($input: UpdateCostRuleInput!){
updateCostRule(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"skuId": "number",
"vendorId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"cost": "number"
}
}
mutation updateCostRule($input: UpdateCostRuleInput!){
updateCostRule(input: $input){
}
}
{
"input": {
"id": "number",
"skuId": "number",
"vendorId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"cost": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateCostRule": {}
}
}
Delete Cost Rule
Delete a cost rule.
The numerical ID of the cost rule
Example
Request Content-Types:
application/json
Query
mutation deleteCostRule($id: Int!){
deleteCostRule(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteCostRule($id: Int!){
deleteCostRule(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteCostRule": {}
}
}
Price Rules
The queries and mutations for managing your Price Rules.
Fetch Price Rules
Fetches a list of price rules based on filter criteria.
The input object containing variables to order your price rule query. Click here for more information.
The input object containing variables to filter your price rule query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query priceRules($orderBy: OrderByPriceRuleInput, $filter: FilterPriceRuleInput, $limit: Int, $offset: Int){
priceRules(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
skuId
skuName
skuCode
quantity
price
unit
createdAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"skuIds": [
"number"
],
"labelIds": [
"number"
],
"quantityGreaterThanOrEqualTo": "number",
"quantityLessThanOrEqualTo": "number",
"quantityEquals": "number",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query priceRules($orderBy: OrderByPriceRuleInput, $filter: FilterPriceRuleInput, $limit: Int, $offset: Int){
priceRules(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
skuId
skuName
skuCode
quantity
price
unit
createdAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"skuIds": [
"number"
],
"labelIds": [
"number"
],
"quantityGreaterThanOrEqualTo": "number",
"quantityLessThanOrEqualTo": "number",
"quantityEquals": "number",
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"priceRules": [
{
"id": "integer",
"accountId": "integer",
"skuId": "integer",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"price": "number",
"unit": "string",
"createdAt": "string"
}
]
}
}
Fetch Price Rule
Fetches a price rule by id.
The numerical ID of the price rule.
Example
Request Content-Types:
application/json
Query
query priceRule($id: Int!){
priceRule(id: $id){
id
accountId
skuId
skuName
skuCode
quantity
price
unit
createdAt
}
}
Variables
{
"id": "integer"
}
query priceRule($id: Int!){
priceRule(id: $id){
id
accountId
skuId
skuName
skuCode
quantity
price
unit
createdAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"priceRule": {
"id": "integer",
"accountId": "integer",
"skuId": "integer",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"price": "number",
"unit": "string",
"createdAt": "string"
}
}
}
Create Price Rule
Creates a new price rule.
The input object containing price rule fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createPriceRule($input: CreatePriceRuleInput!){
createPriceRule(input: $input){
}
}
Variables
{
"input": {
"skuId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"price": "number"
}
}
mutation createPriceRule($input: CreatePriceRuleInput!){
createPriceRule(input: $input){
}
}
{
"input": {
"skuId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"price": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createPriceRule": {}
}
}
Update Price Rule
Updates a price rule.
The input object containing price rule fields for update. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updatePriceRule($input: UpdatePriceRuleInput!){
updatePriceRule(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"skuId": "number",
"unit": "string",
"quantity": "number",
"price": "number"
}
}
mutation updatePriceRule($input: UpdatePriceRuleInput!){
updatePriceRule(input: $input){
}
}
{
"input": {
"id": "number",
"skuId": "number",
"unit": "string",
"quantity": "number",
"price": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updatePriceRule": {}
}
}
Delete Price Rule
Delete a price rule.
The numerical ID of the price rule
Example
Request Content-Types:
application/json
Query
mutation deletePriceRule($id: Int!){
deletePriceRule(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deletePriceRule($id: Int!){
deletePriceRule(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deletePriceRule": {}
}
}
Line Items
The queries and mutations for managing your Line Items.
Fetch Line Items
Fetches a list of line items based on filter criteria.
(no description)
Example
Request Content-Types:
application/json
Query
query lineItems($filter: FilterLineItemInput){
lineItems(filter: $filter){
id
accountId
skuId
quantity
skuCostId
skuPriceId
defaultPrice
name
description
}
}
Variables
{
"filter": {
"type": "string"
}
}
query lineItems($filter: FilterLineItemInput){
lineItems(filter: $filter){
id
accountId
skuId
quantity
skuCostId
skuPriceId
defaultPrice
name
description
}
}
{
"filter": {
"type": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lineItems": [
{
"id": "integer",
"accountId": "integer",
"skuId": "integer",
"quantity": "number",
"skuCostId": "integer",
"skuPriceId": "integer",
"defaultPrice": "number",
"name": "string",
"description": "string"
}
]
}
}
Fetch Line Item
Fetches a line item by id.
The numerical ID of the line item.
Example
Request Content-Types:
application/json
Query
query lineItem($id: Int!){
lineItem(id: $id){
id
accountId
skuId
quantity
skuCostId
skuPriceId
defaultPrice
name
description
}
}
Variables
{
"id": "integer"
}
query lineItem($id: Int!){
lineItem(id: $id){
id
accountId
skuId
quantity
skuCostId
skuPriceId
defaultPrice
name
description
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lineItem": {
"id": "integer",
"accountId": "integer",
"skuId": "integer",
"quantity": "number",
"skuCostId": "integer",
"skuPriceId": "integer",
"defaultPrice": "number",
"name": "string",
"description": "string"
}
}
}
Create Line Item
Creates a new line item.
The input object containing line item fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createLineItem($input: CreateLineItemInput!){
createLineItem(input: $input){
}
}
Variables
{
"input": {
"skuId": "number",
"skuCostId": "number",
"skuPriceId": "number",
"name": "string",
"description": "string",
"defaultPrice": "number"
}
}
mutation createLineItem($input: CreateLineItemInput!){
createLineItem(input: $input){
}
}
{
"input": {
"skuId": "number",
"skuCostId": "number",
"skuPriceId": "number",
"name": "string",
"description": "string",
"defaultPrice": "number"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createLineItem": {}
}
}
Sales Orders
The queries and mutations for managing your Sales Orders.
Fetch Sales Orders
Fetches a list of sales orders based on filter criteria.
The input object containing variables to order your sales order query. Click here for more information.
The input object containing variables to filter your sales order query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query salesOrders($orderBy: OrderBySalesOrderInput, $filter: FilterSalesOrderInput, $limit: Int, $offset: Int){
salesOrders(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
statusId
statusName
originWarehouseId
altId
customerId
notes
externalNotes
shipDate
cancelByDate
customerPo
billingAddressId
shippingAddressId
subTotal
discountTotal
preDiscountSubTotal
shippingTotal
taxTotal
total
costOfGoodsSold
grossProfit
openDate
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"lotIds": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"userIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"statusIds": [
"number"
],
"customerIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query salesOrders($orderBy: OrderBySalesOrderInput, $filter: FilterSalesOrderInput, $limit: Int, $offset: Int){
salesOrders(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
statusId
statusName
originWarehouseId
altId
customerId
notes
externalNotes
shipDate
cancelByDate
customerPo
billingAddressId
shippingAddressId
subTotal
discountTotal
preDiscountSubTotal
shippingTotal
taxTotal
total
costOfGoodsSold
grossProfit
openDate
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"lotIds": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"userIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"statusIds": [
"number"
],
"customerIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"salesOrders": [
{
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"statusId": "integer",
"statusName": "string",
"originWarehouseId": "integer",
"altId": "string",
"customerId": "integer",
"notes": "string",
"externalNotes": "string",
"customerPo": "string",
"billingAddressId": "integer",
"shippingAddressId": "integer",
"subTotal": "number",
"discountTotal": "number",
"preDiscountSubTotal": "number",
"shippingTotal": "number",
"taxTotal": "number",
"total": "number",
"costOfGoodsSold": "number",
"grossProfit": "number",
"openDate": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Sales Order
Fetches a sales order by id.
The numerical ID of the sales order.
Example
Request Content-Types:
application/json
Query
query salesOrder($id: Int!){
salesOrder(id: $id){
id
displayId
accountId
statusId
statusName
originWarehouseId
altId
customerId
notes
externalNotes
shipDate
cancelByDate
customerPo
billingAddressId
shippingAddressId
subTotal
discountTotal
preDiscountSubTotal
shippingTotal
taxTotal
total
costOfGoodsSold
grossProfit
openDate
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query salesOrder($id: Int!){
salesOrder(id: $id){
id
displayId
accountId
statusId
statusName
originWarehouseId
altId
customerId
notes
externalNotes
shipDate
cancelByDate
customerPo
billingAddressId
shippingAddressId
subTotal
discountTotal
preDiscountSubTotal
shippingTotal
taxTotal
total
costOfGoodsSold
grossProfit
openDate
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"salesOrder": {
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"statusId": "integer",
"statusName": "string",
"originWarehouseId": "integer",
"altId": "string",
"customerId": "integer",
"notes": "string",
"externalNotes": "string",
"customerPo": "string",
"billingAddressId": "integer",
"shippingAddressId": "integer",
"subTotal": "number",
"discountTotal": "number",
"preDiscountSubTotal": "number",
"shippingTotal": "number",
"taxTotal": "number",
"total": "number",
"costOfGoodsSold": "number",
"grossProfit": "number",
"openDate": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Sales Order
Creates a new sales order.
The input object containing sales order fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createSalesOrder($input: CreateSalesOrderInput!){
createSalesOrder(input: $input){
}
}
Variables
{
"input": {
"statusId": "number",
"originWarehouseId": "number",
"altId": "string",
"customerId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"userIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"warehouseId": "number",
"price": "number",
"tax": "number",
"quantity": "number",
"name": "string",
"description": "string",
"bomParentId": "number",
"bomQuantityMultiplier": "number",
"bomIsFixed": "boolean",
"isBomParent": "boolean",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"returns": [
{
"id": "number",
"warehouseId": "number",
"packageItems": [
{
"id": "number",
"warehouseId": "number",
"binId": "number",
"quantity": "number",
"remove": "boolean"
}
],
"returnDate": "object",
"remove": "boolean"
}
],
"shipments": [
{
"id": "number"
}
]
}
}
mutation createSalesOrder($input: CreateSalesOrderInput!){
createSalesOrder(input: $input){
}
}
{
"input": {
"statusId": "number",
"originWarehouseId": "number",
"altId": "string",
"customerId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"userIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"warehouseId": "number",
"price": "number",
"tax": "number",
"quantity": "number",
"name": "string",
"description": "string",
"bomParentId": "number",
"bomQuantityMultiplier": "number",
"bomIsFixed": "boolean",
"isBomParent": "boolean",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"returns": [
{
"id": "number",
"warehouseId": "number",
"packageItems": [
{
"id": "number",
"warehouseId": "number",
"binId": "number",
"quantity": "number",
"remove": "boolean"
}
],
"returnDate": "object",
"remove": "boolean"
}
],
"shipments": [
{
"id": "number"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createSalesOrder": {}
}
}
Update Sales Order
Updates a sales order record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateSalesOrder($input: UpdateSalesOrderInput!){
updateSalesOrder(input: $input){
}
}
Variables
{
"input": {
"statusId": "number",
"originWarehouseId": "number",
"id": "number",
"altId": "string",
"customerId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"userIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"warehouseId": "number",
"price": "number",
"tax": "number",
"quantity": "number",
"name": "string",
"description": "string",
"bomParentId": "number",
"bomQuantityMultiplier": "number",
"bomIsFixed": "boolean",
"isBomParent": "boolean",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"shipments": [
{
"id": "number",
"shipDate": "string",
"packages": [
{
"id": "number",
"trackingNumber": "string",
"items": [
{
"id": "number",
"lineItemId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number"
}
]
}
]
}
]
}
]
}
}
mutation updateSalesOrder($input: UpdateSalesOrderInput!){
updateSalesOrder(input: $input){
}
}
{
"input": {
"statusId": "number",
"originWarehouseId": "number",
"id": "number",
"altId": "string",
"customerId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"userIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"warehouseId": "number",
"price": "number",
"tax": "number",
"quantity": "number",
"name": "string",
"description": "string",
"bomParentId": "number",
"bomQuantityMultiplier": "number",
"bomIsFixed": "boolean",
"isBomParent": "boolean",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"shipments": [
{
"id": "number",
"shipDate": "string",
"packages": [
{
"id": "number",
"trackingNumber": "string",
"items": [
{
"id": "number",
"lineItemId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number"
}
]
}
]
}
]
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateSalesOrder": {}
}
}
Place Shipment
Ships out one of many packages and generates shipping labels and tracking numbers.
The numerical ID of the order you wish to place all shipments for.
The numerical ID of the shipment you wish to place. salesOrderId is required when using this field.
The numerical ID of the package you wish to ship. salesOrderId and shipmentId are required when using this field.
Example
Request Content-Types:
application/json
Query
mutation placeShipment($salesOrderId: Int, $shipmentId: Int, $packageId: Int){
placeShipment(salesOrderId: $salesOrderId, shipmentId: $shipmentId, packageId: $packageId){
}
}
Variables
{
"salesOrderId": "integer",
"shipmentId": "integer",
"packageId": "integer"
}
mutation placeShipment($salesOrderId: Int, $shipmentId: Int, $packageId: Int){
placeShipment(salesOrderId: $salesOrderId, shipmentId: $shipmentId, packageId: $packageId){
}
}
{
"salesOrderId": "integer",
"shipmentId": "integer",
"packageId": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"placeShipment": {}
}
}
Cancel Shipment
Cancels a placed shipment and returns the inventory to committed.
The numerical ID of the shipment you wish to cancel. This will return all shipped inventory to committed.
Example
Request Content-Types:
application/json
Query
mutation cancelShipment($shipmentId: Int){
cancelShipment(shipmentId: $shipmentId){
}
}
Variables
{
"shipmentId": "integer"
}
mutation cancelShipment($shipmentId: Int){
cancelShipment(shipmentId: $shipmentId){
}
}
{
"shipmentId": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"cancelShipment": {}
}
}
Receive Return
Marks an RMA as complete.
The numerical ID of the return you wish to receive.
Example
Request Content-Types:
application/json
Query
mutation receiveReturn($returnId: Int){
receiveReturn(returnId: $returnId){
}
}
Variables
{
"returnId": "integer"
}
mutation receiveReturn($returnId: Int){
receiveReturn(returnId: $returnId){
}
}
{
"returnId": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"receiveReturn": {}
}
}
Delete Sales Order
Delete a sales order record.
The numerical ID of the sales order.
Example
Request Content-Types:
application/json
Query
mutation deleteSalesOrder($id: Int!){
deleteSalesOrder(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteSalesOrder($id: Int!){
deleteSalesOrder(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteSalesOrder": {}
}
}
Ship Station
The queries and mutations for interacting with the ShipStation API.
Get Carriers
Gets carriers from ShipStation.
Example
Request Content-Types:
application/json
Try it now
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"getCarriers": {}
}
}
Get Rates
Gets rates from ShipStation based on the provided Sales Order ID, or specified package information.
The input object containing variables to pull rates from ShipStation.
Example
Request Content-Types:
application/json
Query
query getRates($input: GetRatesInput!){
getRates(input: $input){
}
}
Variables
{
"input": {
"carrierCode": "string",
"weight": "number",
"length": "number",
"width": "number",
"height": "number",
"salesOrderId": "number",
"fromPostalCode": "string",
"toState": "string",
"toCountry": "string",
"toPostalCode": "string",
"toCity": "string"
}
}
query getRates($input: GetRatesInput!){
getRates(input: $input){
}
}
{
"input": {
"carrierCode": "string",
"weight": "number",
"length": "number",
"width": "number",
"height": "number",
"salesOrderId": "number",
"fromPostalCode": "string",
"toState": "string",
"toCountry": "string",
"toPostalCode": "string",
"toCity": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"getRates": {}
}
}
Get Import Exceptions
Gets all import exceptions associated with the account.
Example
Request Content-Types:
application/json
Try it now
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"getImportExceptions": [
{
"id": "integer",
"shipStationOrderId": "string",
"data": "string"
}
]
}
}
Pull Shipments
Pulls shipment data from ShipStation based on the provided Sales Order IDs, and updates the package tracking numbers.
The input object containing variables to pull your shipment data from ShipStation.
Example
Request Content-Types:
application/json
Query
mutation pullShipments($input: PullShipmentsInput!){
pullShipments(input: $input){
}
}
Variables
{
"input": {
"salesOrderIds": [
"number"
]
}
}
mutation pullShipments($input: PullShipmentsInput!){
pullShipments(input: $input){
}
}
{
"input": {
"salesOrderIds": [
"number"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"pullShipments": {}
}
}
Push Sales Orders
Pushes package data to ShipStation and updates them with the resulting ShipStation Order IDs.
The input object containing variables to push your Sales Orders to ShipStation.
Example
Request Content-Types:
application/json
Query
mutation pushSalesOrders($input: [PushSalesOrdersInput]!){
pushSalesOrders(input: $input){
}
}
Variables
{
"input": [
{
"salesOrderId": "number",
"shipmentId": "number",
"packageId": "number"
}
]
}
mutation pushSalesOrders($input: [PushSalesOrdersInput]!){
pushSalesOrders(input: $input){
}
}
{
"input": [
{
"salesOrderId": "number",
"shipmentId": "number",
"packageId": "number"
}
]
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"pushSalesOrders": {}
}
}
Pull Sales Orders
Pulls order data from ShipStation and creates Sales Orders with it.
The input object containing variables to pull Sales Orders from ShipStation.
Example
Request Content-Types:
application/json
Query
mutation pullSalesOrders($input: PullSalesOrdersInput){
pullSalesOrders(input: $input){
}
}
Variables
{
"input": {
"shipStationOrderIds": [
"string"
],
"statusFilters": [
"string"
],
"isTrialRun": "boolean",
"isLastImportIgnored": "boolean"
}
}
mutation pullSalesOrders($input: PullSalesOrdersInput){
pullSalesOrders(input: $input){
}
}
{
"input": {
"shipStationOrderIds": [
"string"
],
"statusFilters": [
"string"
],
"isTrialRun": "boolean",
"isLastImportIgnored": "boolean"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"pullSalesOrders": {}
}
}
Delete Import Exception
Delete an import exception record.
The numberical ID of the import exception.
Example
Request Content-Types:
application/json
Query
mutation deleteImportException($id: Int!){
deleteImportException(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteImportException($id: Int!){
deleteImportException(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteImportException": {}
}
}
Purchase Orders
The queries and mutations for managing your Purchase Orders.
Fetch Purchase Orders
Fetches a list of purchase orders based on filter criteria.
The input object containing variables to order your purchase order query. Click here for more information.
The input object containing variables to filter your purchase order query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query purchaseOrders($orderBy: OrderByPurchaseOrderInput, $filter: FilterPurchaseOrderInput, $limit: Int, $offset: Int){
purchaseOrders(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
warehouseId
vendorId
statusId
statusName
notes
externalNotes
issuedDate
dueDate
quickBooksId
quickBooksSyncToken
total
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"vendorIds": [
"number"
],
"statusIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query purchaseOrders($orderBy: OrderByPurchaseOrderInput, $filter: FilterPurchaseOrderInput, $limit: Int, $offset: Int){
purchaseOrders(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
warehouseId
vendorId
statusId
statusName
notes
externalNotes
issuedDate
dueDate
quickBooksId
quickBooksSyncToken
total
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"vendorIds": [
"number"
],
"statusIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"purchaseOrders": [
{
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"warehouseId": "integer",
"vendorId": "integer",
"statusId": "integer",
"statusName": "string",
"notes": "string",
"externalNotes": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string",
"total": "number",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Purchase Order
Fetches a purchase order by id.
The numerical ID of the purchase order.
Example
Request Content-Types:
application/json
Query
query purchaseOrder($id: Int!){
purchaseOrder(id: $id){
id
displayId
accountId
altId
warehouseId
vendorId
statusId
statusName
notes
externalNotes
issuedDate
dueDate
quickBooksId
quickBooksSyncToken
total
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query purchaseOrder($id: Int!){
purchaseOrder(id: $id){
id
displayId
accountId
altId
warehouseId
vendorId
statusId
statusName
notes
externalNotes
issuedDate
dueDate
quickBooksId
quickBooksSyncToken
total
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"purchaseOrder": {
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"warehouseId": "integer",
"vendorId": "integer",
"statusId": "integer",
"statusName": "string",
"notes": "string",
"externalNotes": "string",
"quickBooksId": "integer",
"quickBooksSyncToken": "string",
"total": "number",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Purchase Order
Creates a new purchase order.
The input object containing purchase order fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createPurchaseOrder($input: CreatePurchaseOrderInput!){
createPurchaseOrder(input: $input){
}
}
Variables
{
"input": {
"altId": "string",
"warehouseId": "number",
"vendorId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"cost": "number",
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"receipts": [
{
"id": "number",
"lineItems": [
{
"lineItemId": "number",
"quantity": "number",
"cost": "number",
"remove": "boolean"
}
],
"altId": "string",
"notes": "string",
"statusId": "number",
"dueDate": "object"
}
]
}
}
mutation createPurchaseOrder($input: CreatePurchaseOrderInput!){
createPurchaseOrder(input: $input){
}
}
{
"input": {
"altId": "string",
"warehouseId": "number",
"vendorId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"cost": "number",
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"receipts": [
{
"id": "number",
"lineItems": [
{
"lineItemId": "number",
"quantity": "number",
"cost": "number",
"remove": "boolean"
}
],
"altId": "string",
"notes": "string",
"statusId": "number",
"dueDate": "object"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createPurchaseOrder": {}
}
}
Update Purchase Order
Updates a purchase order record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updatePurchaseOrder($input: UpdatePurchaseOrderInput!){
updatePurchaseOrder(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"altId": "string",
"warehouseId": "number",
"vendorId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"cost": "number",
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"receipts": [
{
"id": "number",
"lineItems": [
{
"lineItemId": "number",
"quantity": "number",
"cost": "number",
"remove": "boolean"
}
],
"altId": "string",
"notes": "string",
"statusId": "number"
}
]
}
}
mutation updatePurchaseOrder($input: UpdatePurchaseOrderInput!){
updatePurchaseOrder(input: $input){
}
}
{
"input": {
"id": "number",
"altId": "string",
"warehouseId": "number",
"vendorId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"cost": "number",
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"receipts": [
{
"id": "number",
"lineItems": [
{
"lineItemId": "number",
"quantity": "number",
"cost": "number",
"remove": "boolean"
}
],
"altId": "string",
"notes": "string",
"statusId": "number"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updatePurchaseOrder": {}
}
}
Delete Purchase Order
Delete a purchase order record.
The numerical ID of the purchase order.
Example
Request Content-Types:
application/json
Query
mutation deletePurchaseOrder($id: Int!){
deletePurchaseOrder(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deletePurchaseOrder($id: Int!){
deletePurchaseOrder(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deletePurchaseOrder": {}
}
}
Work Orders
The queries and mutations for managing your Work Orders.
Fetch Work Orders
Fetches a list of work orders based on filter criteria.
The input object containing variables to order your work order query. Click here for more information.
The input object containing variables to filter your work order query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query workOrders($orderBy: OrderByWorkOrderInput, $filter: FilterWorkOrderInput, $limit: Int, $offset: Int){
workOrders(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
originWarehouseId
statusId
notes
externalNotes
startOn
dueDate
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"statusIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query workOrders($orderBy: OrderByWorkOrderInput, $filter: FilterWorkOrderInput, $limit: Int, $offset: Int){
workOrders(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
originWarehouseId
statusId
notes
externalNotes
startOn
dueDate
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"statusIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"workOrders": [
{
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"originWarehouseId": "integer",
"statusId": "integer",
"notes": "string",
"externalNotes": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Work Order
Fetches a work order by id.
The numerical ID of the work order.
Example
Request Content-Types:
application/json
Query
query workOrder($id: Int!){
workOrder(id: $id){
id
displayId
accountId
altId
originWarehouseId
statusId
notes
externalNotes
startOn
dueDate
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query workOrder($id: Int!){
workOrder(id: $id){
id
displayId
accountId
altId
originWarehouseId
statusId
notes
externalNotes
startOn
dueDate
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"workOrder": {
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"originWarehouseId": "integer",
"statusId": "integer",
"notes": "string",
"externalNotes": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Work Order
Creates a new work order.
The input object containing work order fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createWorkOrder($input: CreateWorkOrderInput!){
createWorkOrder(input: $input){
}
}
Variables
{
"input": {
"altId": "string",
"originWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"quantity": "number",
"name": "string",
"description": "string",
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"assemblies": [
{
"id": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"startOn": "object",
"dueDate": "object"
}
}
mutation createWorkOrder($input: CreateWorkOrderInput!){
createWorkOrder(input: $input){
}
}
{
"input": {
"altId": "string",
"originWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"quantity": "number",
"name": "string",
"description": "string",
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"assemblies": [
{
"id": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"startOn": "object",
"dueDate": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createWorkOrder": {}
}
}
Update Work Order
Updates a work order record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateWorkOrder($input: UpdateWorkOrderInput!){
updateWorkOrder(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"altId": "string",
"originWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"quantity": "number",
"name": "string",
"description": "string",
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"assemblies": [
{
"id": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"startOn": "object",
"dueDate": "object"
}
}
mutation updateWorkOrder($input: UpdateWorkOrderInput!){
updateWorkOrder(input: $input){
}
}
{
"input": {
"id": "number",
"altId": "string",
"originWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"quantity": "number",
"name": "string",
"description": "string",
"billOfMaterials": [
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
],
"remove": "boolean"
}
],
"assemblies": [
{
"id": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
],
"startOn": "object",
"dueDate": "object"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateWorkOrder": {}
}
}
Delete Work Order
Delete a work order record.
The numerical ID of the work order.
Example
Request Content-Types:
application/json
Query
mutation deleteWorkOrder($id: Int!){
deleteWorkOrder(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteWorkOrder($id: Int!){
deleteWorkOrder(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteWorkOrder": {}
}
}
Transfers
The queries and mutations for managing your Transfers.
Fetch Transfers
Fetches a list of transfers based on filter criteria.
The input object containing variables to order your transfer query. Click here for more information.
The input object containing variables to filter your transfer query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query transfers($orderBy: OrderByTransferInput, $filter: FilterTransferInput, $limit: Int, $offset: Int){
transfers(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
originWarehouseId
destinationWarehouseId
statusId
notes
externalNotes
issuedDate
dueDate
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"statusIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
query transfers($orderBy: OrderByTransferInput, $filter: FilterTransferInput, $limit: Int, $offset: Int){
transfers(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
displayId
accountId
altId
originWarehouseId
destinationWarehouseId
statusId
notes
externalNotes
issuedDate
dueDate
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"statusIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"transfers": [
{
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"originWarehouseId": "integer",
"destinationWarehouseId": "integer",
"statusId": "integer",
"notes": "string",
"externalNotes": "string",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Transfer
Fetches a transfer by id.
The numerical ID of the transfer.
Example
Request Content-Types:
application/json
Query
query transfer($id: Int!){
transfer(id: $id){
id
displayId
accountId
altId
originWarehouseId
destinationWarehouseId
statusId
notes
externalNotes
issuedDate
dueDate
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query transfer($id: Int!){
transfer(id: $id){
id
displayId
accountId
altId
originWarehouseId
destinationWarehouseId
statusId
notes
externalNotes
issuedDate
dueDate
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"transfer": {
"id": "integer",
"displayId": "integer",
"accountId": "integer",
"altId": "string",
"originWarehouseId": "integer",
"destinationWarehouseId": "integer",
"statusId": "integer",
"notes": "string",
"externalNotes": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Transfer
Creates a new transfer.
The input object containing transfer fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createTransfer($input: CreateTransferInput!){
createTransfer(input: $input){
}
}
Variables
{
"input": {
"altId": "string",
"originWarehouseId": "number",
"destinationWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
]
}
}
mutation createTransfer($input: CreateTransferInput!){
createTransfer(input: $input){
}
}
{
"input": {
"altId": "string",
"originWarehouseId": "number",
"destinationWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createTransfer": {}
}
}
Update Transfer
Updates a transfer record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateTransfer($input: UpdateTransferInput!){
updateTransfer(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"altId": "string",
"originWarehouseId": "number",
"destinationWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
]
}
}
mutation updateTransfer($input: UpdateTransferInput!){
updateTransfer(input: $input){
}
}
{
"input": {
"id": "number",
"altId": "string",
"originWarehouseId": "number",
"destinationWarehouseId": "number",
"statusId": "number",
"notes": "string",
"externalNotes": "string",
"issuedDate": "object",
"dueDate": "object",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"lineItems": [
{
"id": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
],
"receivements": [
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateTransfer": {}
}
}
Delete Transfer
Delete a transfer record.
The numerical ID of the transfer.
Example
Request Content-Types:
application/json
Query
mutation deleteTransfer($id: Int!){
deleteTransfer(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteTransfer($id: Int!){
deleteTransfer(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteTransfer": {}
}
}
Filters
The queries and mutations for managing your Module Filters.
Fetch Filters
Fetches a list of filters based on filter criteria.
The input object containing variables to filter your product query. Click here for more information.
Example
Request Content-Types:
application/json
Query
query filters($filter: FilterFilterInput!){
filters(filter: $filter){
id
userId
name
color
module
queryParams
}
}
Variables
{
"filter": {
"module": "string"
}
}
query filters($filter: FilterFilterInput!){
filters(filter: $filter){
id
userId
name
color
module
queryParams
}
}
{
"filter": {
"module": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"filters": [
{
"id": "integer",
"userId": "integer",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
]
}
}
Fetch Filter
Fetches a filter by id.
The numerical ID of the filter.
Example
Request Content-Types:
application/json
Query
query filter($id: Int!){
filter(id: $id){
id
userId
name
color
module
queryParams
}
}
Variables
{
"id": "integer"
}
query filter($id: Int!){
filter(id: $id){
id
userId
name
color
module
queryParams
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"filter": {
"id": "integer",
"userId": "integer",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
}
}
Create Filter
Creates a new filter.
The input object containing product fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createFilter($input: CreateFilterInput!){
createFilter(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
}
mutation createFilter($input: CreateFilterInput!){
createFilter(input: $input){
}
}
{
"input": {
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createFilter": {}
}
}
Update Filter
Updates a filter reecord.
The input object containing filter fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateFilter($input: UpdateFilterInput!){
updateFilter(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
}
mutation updateFilter($input: UpdateFilterInput!){
updateFilter(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateFilter": {}
}
}
Delete Filter
Deletes a filter record.
The numerical ID of the filter.
Example
Request Content-Types:
application/json
Query
mutation deleteFilter($id: Int!){
deleteFilter(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteFilter($id: Int!){
deleteFilter(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteFilter": {}
}
}
Custom Fields
The queries and mutations for managing your Custom Fields.
Fetch Custom Fields
Fetches a list of custom fields based on filter criteria.
The input object containing variables to order your custom field query. Click here for more information.
The input object containing variables to filter your custom field query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query customFields($orderBy: OrderByCustomFieldInput, $filter: FilterCustomFieldInput, $limit: Int, $offset: Int){
customFields(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
module
displayName
name
value
sortOrder
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string",
"modules": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
query customFields($orderBy: OrderByCustomFieldInput, $filter: FilterCustomFieldInput, $limit: Int, $offset: Int){
customFields(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
module
displayName
name
value
sortOrder
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string",
"modules": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"customFields": [
{
"id": "integer",
"accountId": "integer",
"module": "string",
"displayName": "string",
"name": "string",
"value": "string",
"sortOrder": "integer",
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Custom Field
Fetches a custom field by id.
The numerical ID of the custom field.
Example
Request Content-Types:
application/json
Query
query customField($id: Int!){
customField(id: $id){
id
accountId
module
displayName
name
value
sortOrder
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query customField($id: Int!){
customField(id: $id){
id
accountId
module
displayName
name
value
sortOrder
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"customField": {
"id": "integer",
"accountId": "integer",
"module": "string",
"displayName": "string",
"name": "string",
"value": "string",
"sortOrder": "integer",
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Custom Field
Creates a new custom field.
The input object containing custom field fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createCustomField($input: CreateCustomFieldInput!){
createCustomField(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"sortOrder": "number",
"module": [
"string"
]
}
}
mutation createCustomField($input: CreateCustomFieldInput!){
createCustomField(input: $input){
}
}
{
"input": {
"name": "string",
"sortOrder": "number",
"module": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createCustomField": {}
}
}
Update Custom Field
Updates a custom field record.
The input object containing custom field fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateCustomField($input: UpdateCustomFieldInput!){
updateCustomField(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"sortOrder": "number",
"name": "string"
}
}
mutation updateCustomField($input: UpdateCustomFieldInput!){
updateCustomField(input: $input){
}
}
{
"input": {
"id": "number",
"sortOrder": "number",
"name": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateCustomField": {}
}
}
Delete Custom Field
Deletes a custom field record.
The numerical ID of the custom field.
Example
Request Content-Types:
application/json
Query
mutation deleteCustomField($id: Int!){
deleteCustomField(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteCustomField($id: Int!){
deleteCustomField(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteCustomField": {}
}
}
Labels
The queries and mutations for managing your Labels.
Fetch Labels
Fetches a list of labels based on filter criteria.
The input object containing variables to order your label query. Click here for more information.
The input object containing variables to filter your label query. Click here for more information.
The number of records you wish to fetch.
The number of records to skip over in your request.
Example
Request Content-Types:
application/json
Query
query labels($orderBy: OrderByLabelInput, $filter: FilterLabelInput, $limit: Int, $offset: Int){
labels(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
name
color
modules
createdAt
updatedAt
}
}
Variables
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string",
"modules": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
query labels($orderBy: OrderByLabelInput, $filter: FilterLabelInput, $limit: Int, $offset: Int){
labels(orderBy: $orderBy, filter: $filter, limit: $limit, offset: $offset){
id
accountId
name
color
modules
createdAt
updatedAt
}
}
{
"orderBy": {
"column": "string",
"order": "string"
},
"filter": {
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string",
"modules": [
"string"
]
},
"limit": "integer",
"offset": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"labels": [
{
"id": "integer",
"accountId": "integer",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
]
}
}
Fetch Label
Fetches a label by id.
The numerical ID of the label.
Example
Request Content-Types:
application/json
Query
query label($id: Int!){
label(id: $id){
id
accountId
name
color
modules
createdAt
updatedAt
}
}
Variables
{
"id": "integer"
}
query label($id: Int!){
label(id: $id){
id
accountId
name
color
modules
createdAt
updatedAt
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"label": {
"id": "integer",
"accountId": "integer",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
}
}
Create Label
Creates a new label.
The input object containing label fields for insertion. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation createLabel($input: CreateLabelInput!){
createLabel(input: $input){
}
}
Variables
{
"input": {
"name": "string",
"color": "string",
"modules": [
"string"
]
}
}
mutation createLabel($input: CreateLabelInput!){
createLabel(input: $input){
}
}
{
"input": {
"name": "string",
"color": "string",
"modules": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createLabel": {}
}
}
Update Label
Updates a label record.
The input object containing label fields for updating. Click here for more information.
Example
Request Content-Types:
application/json
Query
mutation updateLabel($input: UpdateLabelInput!){
updateLabel(input: $input){
}
}
Variables
{
"input": {
"id": "number",
"name": "string",
"color": "string",
"modules": [
"string"
]
}
}
mutation updateLabel($input: UpdateLabelInput!){
updateLabel(input: $input){
}
}
{
"input": {
"id": "number",
"name": "string",
"color": "string",
"modules": [
"string"
]
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"updateLabel": {}
}
}
Delete Label
Deletes a label record.
The numerical ID of the label.
Example
Request Content-Types:
application/json
Query
mutation deleteLabel($id: Int!){
deleteLabel(id: $id){
}
}
Variables
{
"id": "integer"
}
mutation deleteLabel($id: Int!){
deleteLabel(id: $id){
}
}
{
"id": "integer"
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"deleteLabel": {}
}
}
History
The queries managing your History Records.
Fetch History
Fetches a list of history records based on filter criteria.
The input object containing variables to filter your history query. Click here for more information.
(no description)
Example
Request Content-Types:
application/json
Query
query history($filter: FilterHistoryInput, $orderBy: OrderByHistoryInput){
history(filter: $filter, orderBy: $orderBy){
id
accountId
userId
actionId
tableId
recordId
description
metadata
createdAt
}
}
Variables
{
"filter": {
"table": [
"string"
],
"userId": "number",
"recordId": "number",
"createdAfter": "string",
"createdBefore": "string"
},
"orderBy": {
"column": "string",
"order": "string"
}
}
query history($filter: FilterHistoryInput, $orderBy: OrderByHistoryInput){
history(filter: $filter, orderBy: $orderBy){
id
accountId
userId
actionId
tableId
recordId
description
metadata
createdAt
}
}
{
"filter": {
"table": [
"string"
],
"userId": "number",
"recordId": "number",
"createdAfter": "string",
"createdBefore": "string"
},
"orderBy": {
"column": "string",
"order": "string"
}
}
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"history": [
{
"id": "integer",
"accountId": "integer",
"userId": "integer",
"actionId": "string",
"tableId": "string",
"recordId": "integer",
"description": "string",
"metadata": "string",
"createdAt": "string"
}
]
}
}
Schema Definitions
APIKey: object
The object containing all of the fields for a particular api key.
Example
{
"id": "number",
"accountId": "number",
"userId": "number",
"token": "string",
"createdAt": "string",
"updatedAt": "string"
}
APIKeyPayload: object
The return type for API Key queries and mutations.
- apiKey:
Example
{
"apiKey": {
"id": "number",
"accountId": "number",
"userId": "number",
"token": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
Account: object
The object containing all of the fields for a particular account. An account object is created when you register with Lead Commerce.
- id:
-
The numerical ID of the account.
- name:
-
The name of the account.
- domain:
-
The full domain of the account if it is hosted on a custom domain.
Example
{
"id": "number",
"name": "string",
"domain": "string"
}
AccountPayload: object
The return type for account queries and mutations.
- account:
Example
{
"account": {
"id": "number",
"name": "string",
"domain": "string"
}
}
Address: object
The object containing all of the fields for a particular address.
- id:
-
The numerical ID of the address.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this address.
- name:
-
The nickname of the address (e.g., John Smith's House).
- fullAddress:
-
The full address, in US address format.
- address1:
-
The street address.
- address2:
-
The secondary street address.
- address3:
-
The tertiary street address.
- postalCode:
-
The postal code of the address.
- city:
-
The city the address resides in.
- district:
-
The code of the state/province/territory the address resides in.
- country:
-
The code of the country the address resides in.
Example
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
AddressPayload: object
The return type for address queries and mutations.
- address:
-
The Address object.
Example
{
"address": {
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
}
Adjustment: object
The object containing all of the fields for a particular adjustment.
- quantity:
-
The quantity adjusted.
- description:
-
The description of the adjustment, providing the reason for the adjustment.
- lotId:
-
The lot created or adjusted by this adjustment.
- skuId:
-
The SKU adjusted.
- skuName:
-
The name of the SKU.
- skuDescription:
-
The description of the SKU.
- warehouseId:
-
The warehouse in which the adjustment was made.
- warehouseName:
-
The name of the warehouse in which the adjustment was made.
- createdAt:
-
The DateTime when the adjustment was created.
Example
{
"quantity": "number",
"description": "string",
"lotId": "number",
"skuId": "number",
"skuName": "string",
"skuDescription": "string",
"warehouseId": "number",
"warehouseName": "string",
"createdAt": "string"
}
AdjustmentReason: string
The options for adjustment reasons.
-
objectDamaged
-
objectExpired
-
objectInitial_Adjustment
-
objectMiscount
-
objectPromotional
-
objectVendor
-
objectReturn
-
objectOther
Assembly: object
The object containing all of the fields for a particular assembly.
Example
{
"id": "number",
"lineItemId": "number",
"quantity": "number",
"lot": {
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"workOrderAssemblyId": "number",
"workOrderId": "number",
"workOrderBOMCOGS": "number",
"workOrderBOMLots": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "number"
}
]
}
}
AssemblyInput: object
The input variables for creating assemblies.
- id:
-
The numerical ID of the assembly if it already exists. Required for updating.
- lineItemId:
-
The numerical ID of the Line Item being received.
- binId:
-
The numerical ID of the assembly's Bin Location.
- quantity:
-
The quantity received. Cannot exceed quantity ordered.
- lotNumber:
-
The lot number of the assembled inventory.
- altLotNumber:
-
The alternative identifier of the lot, for custom metadata.
- serialNumber:
-
The serial number of the assembled inventory.
- manufactureDate:
-
The date this piece of inventory was assembled.
- expirationDate:
-
The date this piece of inventory expires.
- remove:
-
If this is set to true, it will remove the assembly.
Example
{
"id": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
AssemblyMaterial: object
The object containing all of the field for a particular assembly material.
- id:
-
The numerical id of the Assembly Material. Used for updating BOMs on SKUs.
- skuId:
-
The numerical ID of the SKU associated with this assembly material.
- name:
-
The name/code of the SKU associated with this assembly material.
- description:
-
The description of the SKU associated with this assembly material.
- quantity:
-
The quantity being consumed by a single assembly unit.
- isFixed:
-
The flag for indicating whether or not a material's quantity is static, or scales linearly with assembly units.
- lots:
-
The array of Lots consumed by this material item.
- lotMappings:
-
The array of Lot Maps awaiting transfer.
Example
{
"id": "number",
"skuId": "number",
"name": "string",
"description": "string",
"quantity": "number",
"isFixed": "boolean",
"lots": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"workOrderAssemblyId": "number",
"workOrderId": "number",
"workOrderBOMCOGS": "number",
"workOrderBOMLots": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number"
}
]
}
]
}
AssemblyMaterialInput: object
The input variables for creating an assembly material.
- id:
-
The numerical id of the Assembly Material. Used for updating BOMs on SKUs.
- skuId:
-
The numerical ID of the SKU associated with this assembly material.
- lotIds:
-
The optional array of Lot IDs to pull inventory from. If this is not specified, then lots will be chosen automatically.
- quantity:
-
The quantity being consumed by a single assembly unit.
- isFixed:
-
The flag for indicating whether or not a material's quantity is static, or scales linearly with assembly units.
- remove:
-
If this is set to true, it will remove the assembly material from the assigned object.
Example
{
"id": "number",
"skuId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"isFixed": "boolean",
"remove": "boolean"
}
AuthModule: string
The options for label modules.
-
objectADDRESSES
-
objectADJUSTMENTS
-
objectAPI_KEYS
-
objectAUTOMATIONS
-
objectBIN_LOCATIONS
-
objectBULK_UPDATES
-
objectCALENDAR
-
objectCOGS
-
objectCONTACTS
-
objectCOST_RULES
-
objectCUSTOM_FIELDS
-
objectCUSTOMERS
-
objectDASHBOARDS
-
objectEMAIL
-
objectERROR_LOGS
-
objectEXPORTS
-
objectFILTERS
-
objectGROSS_MARGIN
-
objectHISTORY
-
objectIMPORTS
-
objectINVOICES
-
objectLABELS
-
objectLINE_ITEMS
-
objectLOTS
-
objectNOTIFICATIONS
-
objectPAYMENTS
-
objectPRICE_RULES
-
objectPRODUCTS
-
objectPROJECTS
-
objectPURCHASE_ORDERS
-
objectRECEIPTS
-
objectRECEIVEMENTS
-
objectRESET
-
objectRETURNS
-
objectSALES_ORDERS
-
objectSHIPMENTS
-
objectSKU_COSTS
-
objectSKU_PRICES
-
objectSKU_VELOCITY
-
objectSKUS
-
objectSTOCK_HISTORY
-
objectSTRIPE
-
objectTEMPLATES
-
objectTRANSFERS
-
objectUSER_ROLES
-
objectUSERS
-
objectVENDORS
-
objectWAREHOUSES
-
objectWORK_ORDERS
-
objectWORKFLOWS
Automation: object
The object containing all of the fields for a particular automation.
- id:
-
The numerical ID of the automation.
- isPaused:
-
The flag that determines whether or not the process will run.
- displayId:
-
The display ID of the automation.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this automation.
- workflowId:
-
The numerical ID of the Workflow associated with this automation.
- type:
-
The type of action performed when this automation runs.
- emailSettings:
-
The configuration for SEND_EMAIL automation actions.
- shipStationStatusFilters:
-
The status filters for ship station actions.
- createdAt:
-
The DateTime when the automation was created.
- updatedAt:
-
The DateTime when the automation was updated.
- lastRun:
-
The DateTime when the automation was last run.
- interval:
-
The interval at which the automation runs if it is set to automatically run.
Example
{
"id": "number",
"isPaused": "boolean",
"displayId": "string",
"accountId": "number",
"workflowId": "number",
"type": "string",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"shipStationStatusFilters": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"lastRun": "string",
"interval": "string"
}
AutomationActionType: string
The options for automation action types.
-
objectSEND_EMAIL
-
The automation action for sending an email when an automation runs.
-
objectWORKFLOW
-
The automation action for evaluating a workflow when an automation runs.
-
objectPULL_SHIP_STATION_ORDERS
-
The automation action for pulling sales orders from ship station on a schedule.
AutomationInterval: string
The options for automation run intervals.
-
objectFIFTEEN_MINUTES
-
Runs once per fifteen minutes.
-
objectHOURLY
-
Runs once per hour on the hour.
-
objectDAILY
-
Runs once per day at 00:00.
-
objectWEEKLY
-
Runs once per week at 00:00 on Sunday.
-
objectMONTHLY
-
Runs once per month at 00:00 on the 1st day of the month.
AutomationPayload: object
The return type for automation queries and mutations.
- automation:
-
The Automation object.
Example
{
"automation": {
"id": "number",
"isPaused": "boolean",
"displayId": "string",
"accountId": "number",
"workflowId": "number",
"type": "string",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"shipStationStatusFilters": [
"string"
],
"createdAt": "string",
"updatedAt": "string",
"lastRun": "string",
"interval": "string"
}
}
BinLocation: object
The object containing all of the fields for a particular bin location.
- id:
-
The numerical ID of the bin location.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this bin location.
- warehouseId:
-
The numerical ID of the Warehouse associated with this bin location.
- name:
-
The name of the bin location.
- labels:
-
The Labels associated with this bin location.
- customFields:
-
The array of Custom Fields associated with this bin location.
- lots:
-
The Inventory Lots associated with this bin location.
- createdAt:
-
The DateTime when the bin was created.
- updatedAt:
-
The DateTime when the bin was updated.
Example
{
"id": "number",
"accountId": "number",
"warehouseId": "number",
"name": "string",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
{
"id": "number",
"accountId": "number",
"module": "string",
"displayName": "string",
"name": "string",
"value": "string",
"sortOrder": "number",
"createdAt": "string",
"updatedAt": "string"
}
],
"lots": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"workOrderAssemblyId": "number",
"workOrderId": "number",
"workOrderBOMCOGS": "number",
"workOrderBOMLots": [
null
]
}
]
}
BinLocationPayload: object
The return type for bin location queries and mutations.
- binLocation:
-
The BinLocation object.
Example
{
"binLocation": {
"id": "number",
"accountId": "number",
"warehouseId": "number",
"name": "string",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
{
"id": "number",
"accountId": "number",
"module": "string",
"displayName": "string",
"name": "string",
"value": "string",
"sortOrder": "number",
"createdAt": "string",
"updatedAt": "string"
}
],
"lots": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string",
"description": "string",
"quantity": "number",
"originalQuantity": "number",
"quantityAllocated": "number",
"quantityCommitted": "number",
"cost": "number",
"quantityMapped": "number",
"quantityReceived": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"workOrderAssemblyId": "number",
"workOrderId": "number"
}
]
}
}