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"
}
]
}
}
BulkAdjustmentInput: object
The settings for bulk adjustments.
- quantityAdjustment:
-
The quantity of the adjustment.
- binId:
-
The bin to adjust into.
- reason:
-
The reason for adjustment.
Example
{
"quantityAdjustment": "number",
"binId": "number",
"reason": "string"
}
BulkDuplicate: object
The object containing all of the fields for a particular bulk duplicate.
Example
{
"id": "number",
"type": "string",
"createdAt": "string",
"updatedAt": "string"
}
BulkDuplicatePayload: object
The return type for bulk duplicate queries and mutations.
- bulkDuplicate:
-
The Bulk Duplicate object.
Example
{
"bulkDuplicate": {
"id": "number",
"type": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
BulkDuplicateType: string
The options for bulk duplicates.
-
objectSALES_ORDERS
-
objectPURCHASE_ORDERS
BulkQuickBooksSyncPayload: object
The return type for bulk QuickBooks sync mutations.
- success:
-
The success variable.
Example
{
"success": "boolean"
}
BulkSKUActionTypes: string
The options for bulk sku actions.
-
objectPURCHASE_ORDER
-
Creates a purchase order for the provided skus.
-
objectADJUSTMENT
-
Creates an adjustment for the provided skus.
BulkSKUPayload: object
The input for sku bulk actions.
- id:
-
The numeric ID of the SKU.
- vendorId:
-
The numeric ID of the vendor. Required for purchase order bulk actions.
- warehouseId:
-
The numeric ID of the warehouse. Required for purchase order bulk actions.
- statusId:
-
The numeric ID of the status. Optional for purchase order bulk actions.
- cost:
-
The cost of the SKU. Optional for purchase order bulk actions.
- quantity:
-
The quantity of the SKU. Optional for purchase order bulk actions.
- adjustment:
-
The fields for bulk adjustments.
Example
{
"id": "number",
"vendorId": "number",
"warehouseId": "number",
"statusId": "number",
"cost": "number",
"quantity": "number",
"adjustment": {
"quantityAdjustment": "number",
"binId": "number",
"reason": "string"
}
}
BulkSalesOrderActionTypes: string
The options for bulk sales order actions.
-
objectINVOICE
-
Creates an invoice for the provided sales orders.
-
objectSHIPMENT
-
Create a shipment for the provided sales orders.
-
objectPLACE_SHIPMENT
-
Places a shipment for the provides sales orders.
-
objectPAYMENT
-
Adds a payment to the provided sales order.
BulkSalesOrderPayload: object
The input for sales order bulk actions.
- id:
-
The numeric ID of the Sales Order.
- payment:
-
The payment being applied when using the PAYMENT sales order action type.
- shipmentId:
-
The numerical ID of the shipment you wish to place when using the PLACE_SHIPMENT option. id is required when using this field.
- packageId:
-
The numerical ID of the package you wish to ship when using the PLACE_SHIPMENT option. salesOrderId and shipmentId are required when using this field.
Example
{
"id": "number",
"payment": {
"id": "number",
"altId": "string",
"checkNumber": "string",
"amount": "number",
"paymentDate": "object",
"notes": "string",
"source": "string",
"billingAddressId": "number",
"invoices": [
{
"id": "number",
"remove": "boolean"
}
],
"remove": "boolean"
},
"shipmentId": "number",
"packageId": "number"
}
BulkUpdate: object
The object containing all of the fields for a particular bulk update.
Example
{
"id": "number",
"type": "string",
"createdAt": "string",
"updatedAt": "string"
}
BulkUpdatePayload: object
The return type for bulk update queries and mutations.
- bulkUpdate:
-
The Bulk Update object.
Example
{
"bulkUpdate": {
"id": "number",
"type": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
BulkUpdateType: string
The options for bulk updates.
-
objectCUSTOMERS
-
objectSALES_ORDERS
-
objectPURCHASE_ORDERS
-
objectTRANSFERS
-
objectWORK_ORDERS
-
objectPRODUCTS
-
objectSKUS
Carrier: object
- name:
- code:
- accountNumber:
- requiresFundedAccount:
- balance:
- nickname:
- shippingProviderId:
- primary:
Example
{
"name": "string",
"code": "string",
"accountNumber": "string",
"requiresFundedAccount": "boolean",
"balance": "number",
"nickname": "string",
"shippingProviderId": "number",
"primary": "boolean"
}
Cart: object
Example
{
"items": [
{
"sku": {
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number"
}
]
}
]
}
}
]
}
CartItem: object
Example
{
"sku": {
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string"
}
]
}
]
}
}
CategoryInput: object
The input variables for attaching a subcategory.
- id:
-
The numerical ID of the Subcategory.
- remove:
-
If this is set to true, it will remove the subcategory from the assigned category.
Example
{
"id": "number",
"remove": "boolean"
}
ConsolidatedInvoice: object
- payments:
-
The Payments associated with these invoices.
- amountDue:
-
The amount due for these invoices.
- amountPaid:
-
The amount paid to these invoices.
- total:
-
The total amount of the invoices.
- lineItems:
-
The Line Items associated with these invoices.
Example
{
"payments": [
{
"id": "number",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"customer": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"businessName": "string",
"orders": [
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string"
}
]
}
}
]
}
}
]
}
ConsolidatedReceivement: object
The object containing all of the fields for a consolidated receivement.
- receivements:
-
The Receivements associated with these purchase orders.
Example
{
"receivements": [
{
"id": "number",
"purchaseOrderId": "number",
"purchaseOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"warehouseId": "number",
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
]
}
}
}
]
}
ConsolidatedSalesOrder: object
The object containing all of the fields for a consolidated sales order.
- lineItems:
-
The Line Items associated with these sales orders.
Example
{
"lineItems": [
{
"id": "number",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"salesOrderLineItemId": "number",
"warehouseId": "number",
"skuId": "number",
"total": "number",
"price": "number",
"priceRuleId": "number",
"tax": "number",
"quantity": "number",
"type": "string",
"name": "string",
"description": "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": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string"
}
]
}
]
}
]
}
Contact: object
The object containing all of the fields for a particular contact.
- id:
-
The numerical ID of the contact.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this contact.
- name:
-
The name of the contact.
- phone:
-
The phone number of the contact.
- email:
-
The email address of the contact.
Example
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
ContactPayload: object
The return type for contact queries and mutations.
- contact:
Example
{
"contact": {
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
}
CostRule: object
The object containing all of the fields for a particular cost rule.
- id:
-
The numerical ID of the cost rule.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this cost.
- vendorId:
-
The numerical ID of the Vendor associated with this cost.
- vendorName:
-
The name of the Vendor associated with this cost.
- vendorPartNumber:
-
The vendor part number.
- skuId:
-
The numerical ID of the SKU associated with this cost.
- skuName:
-
The description of the SKU associated with this cost.
- skuCode:
-
The code of the SKU associated with this cost.
- quantity:
-
The quantity of units associated with this cost.
- cost:
-
The total cost of the unit (e.g., 500.00 for $500/Pallet).
- unit:
-
The unit associated with this cost (e.g., 'Pallet', 'Pack', 'Box')
- createdAt:
-
The DateTime when the cost rule was created.
Example
{
"id": "number",
"accountId": "number",
"vendorId": "number",
"vendorName": "string",
"vendorPartNumber": "string",
"skuId": "number",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"cost": "number",
"unit": "string",
"createdAt": "string"
}
CostRulePayload: object
The return type for cost rule queries and mutations.
- costRule:
-
The Cost Rule object.
Example
{
"costRule": {
"id": "number",
"accountId": "number",
"vendorId": "number",
"vendorName": "string",
"vendorPartNumber": "string",
"skuId": "number",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"cost": "number",
"unit": "string",
"createdAt": "string"
}
}
CreateAddressInput: object
The input variables for creating addresses.
- name:
-
The nickname of the address (e.g., John Smith's House).
- 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/teritory the address resides in.
- country:
-
The code of the country the address resides in.
Example
{
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
CreateAdjustmentInput: object
The input variables for creating inventory adjustments.
- lotId:
-
The numerical ID of the Lot associated with this adjustment. If this value is specified, the quantity on the specific lot will be adjusted.
- skuId:
-
The numerical ID of the SKU associated with this adjustment. If lotId is not specified, a new lot will be automatically created.
- binId:
-
The numerical ID of the Bin Location associated with this adjustment. If lotId is not specified, then this must be specified.
- quantityAdjustment:
-
The quantity of inventory to adjust.
- reason:
-
The reason for the adjustment.
Example
{
"lotId": "number",
"skuId": "number",
"binId": "number",
"quantityAdjustment": "number",
"reason": "string"
}
CreateAppInput: object
- appName:
-
The name of the app you wish to instantiate.
Example
{
"appName": "string"
}
CreateAutomationInput: object
The input variables for creating automations.
- isPaused:
-
The flag that determines whether or not the process will run.
- type:
-
The type of automation action.
- workflowId:
-
The numerical ID of the workflow associated with this automation.
- emailSettings:
-
The configuration for SEND_EMAIL automation actions.
- shipStationStatusFilters:
-
The status filters for ship station actions.
- interval:
-
The interval at which the automation runs if it is set to automatically run.
Example
{
"isPaused": "boolean",
"type": "string",
"workflowId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"shipStationStatusFilters": [
"string"
],
"interval": "string"
}
CreateBatchEmailInput: object
The input variables for creating a batch email.
- subject:
-
The subject line of the email.
- body:
-
The body of the email that will be pre-pended to any templates you include.
- replyTo:
-
The reply-to address for the email.
- to:
-
The recipient of the email. Will default to the customer email address on sales order templates.
- cc:
-
The carbon copy address to send the email to.
- bcc:
-
The blind carbon copy address to send the email to.
- templateIds:
-
The ids of the templates you wish to append to the email body. You should only include templates sharing the same document subtype.
- jobs:
-
The array of record IDs and Tag Params you wish to batch send.
Example
{
"subject": "string",
"body": "string",
"replyTo": "string",
"to": "string",
"cc": "string",
"bcc": "string",
"templateIds": [
"number"
],
"jobs": [
{
"tagParams": [
{
"tag": "string",
"variables": "string"
}
],
"recordId": "number",
"templateIds": [
"number"
]
}
]
}
CreateBinLocationInput: object
The input variables for creating bin locations.
- name:
-
The name of the bin location.
- warehouseId:
-
The numerical ID of the Warehouse associated with this bin location.
- labelIds:
-
The array of Label IDs associated with this bin location.
- customFields:
-
The array of Custom Field keys and values associated with this bin location.
Example
{
"name": "string",
"warehouseId": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
CreateBulkDuplicateInput: object
The input variables for creating bulk duplicates.
- type:
-
The type of bulk duplication.
- filter:
-
The JSON string of the filter for the relevant bulk duplication type (e.g., { "createdAfter": "2020-01-01T00:00:00Z" }).
- statusId:
-
The status id to pass in. Defaults to draft.
Example
{
"type": "string",
"filter": "string",
"statusId": "number"
}
CreateBulkQuickBooksSyncInput: object
The input variables for creating bulk QuickBooks syncs.
- type:
- ids:
-
The record ids to sync.
- expenseAccountId:
-
The Id of the QuickBooks expense account to use to fulfill bills. If not specified, will default to Cost of Goods Sold account.
Example
{
"type": "string",
"ids": [
"number"
],
"expenseAccountId": "number"
}
CreateBulkSKUActionInput: object
The input object containing bulk sku action fields.
- type:
-
The type of bulk sku action.
- skus:
-
The variables associated with this action.
Example
{
"type": "string",
"skus": [
{
"id": "number",
"vendorId": "number",
"warehouseId": "number",
"statusId": "number",
"cost": "number",
"quantity": "number",
"adjustment": {
"quantityAdjustment": "number",
"binId": "number",
"reason": "string"
}
}
]
}
CreateBulkSalesOrderActionInput: object
The input object containing bulk sales order action fields.
- type:
-
The type of bulk sales order action.
- orders:
-
The variables associated with this action.
Example
{
"type": "string",
"orders": [
{
"id": "number",
"payment": {
"id": "number",
"altId": "string",
"checkNumber": "string",
"amount": "number",
"paymentDate": "object",
"notes": "string",
"source": "string",
"billingAddressId": "number",
"invoices": [
{
"id": "number",
"remove": "boolean"
}
],
"remove": "boolean"
},
"shipmentId": "number",
"packageId": "number"
}
]
}
CreateBulkUpdateInput: object
The input variables for creating bulk updates.
- type:
-
The type of bulk update.
- filter:
-
The JSON string of the filter for the relevant bulk update type (e.g., { "createdAfter": "2020-01-01T00:00:00Z" }).
- updatePayload:
-
The JSON string of the fields you wish to update (e.g., { "name": "Updated Record" }).
Example
{
"type": "string",
"filter": "string",
"updatePayload": "string"
}
CreateCostRuleInput: object
The input variables for creating cost rules.
- skuId:
-
The numerical ID of the SKU associated with this cost rule.
- vendorId:
-
The numerical ID of the Vendor associated with this cost rule.
- unit:
-
The unit associated with this cost (e.g., 'Pallet', 'Pack', 'Box')
- vendorPartNumber:
-
The vendor part number.
- quantity:
-
The quantity of units associated with this cost.
- cost:
-
The total cost of the unit (e.g., 500.00 for $500/Pallet).
Example
{
"skuId": "number",
"vendorId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"cost": "number"
}
CreateCustomFieldInput: object
The input variables for creating custom fields.
- name:
-
The name of the custom field (alpha-numeric, underscore-delimeted, e.g., 'alternative_name').
- sortOrder:
-
The numeric value you wish to sort by.
- module:
-
The module that this custom field is available in.
Example
{
"name": "string",
"sortOrder": "number",
"module": [
"string"
]
}
CreateCustomerInput: object
The input variables for creating customers.
- altId:
-
The alternative ID of the customer.
- businessName:
-
The name of the customer.
- termId:
-
The numerical ID of the Term associated with this customer.
- taxExempt:
-
The field indicating whether or not the customer is exempt from sales tax.
- taxRate:
-
The tax rate (%) associated with this customer. Defaults to 0. Can be between 0 and 1 (0% - 100%).
- notes:
-
The notes on this customer.
- contactIds:
-
The array of Contact IDs associated with this customer.
- labelIds:
-
The array of Label IDs associated with this customer.
- customFields:
-
The array of Custom Field keys and values associated with this customer.
- addressIds:
-
The array of Address IDs associated with this customer.
Example
{
"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"
}
]
}
CreateEmailInput: object
The input variables for creating emails.
- subject:
-
The subject line of the email.
- body:
-
The body of the email that will be pre-pended to any templates you include.
- replyTo:
-
The reply-to address for the email.
- to:
-
The recipient of the email. Will default to the customer email address on sales order templates.
- cc:
-
The carbon copy address to send the email to.
- bcc:
-
The blind carbon copy address to send the email to.
- templateIds:
-
The ids of the templates you wish to append to the email body. You should only include templates sharing the same document subtype.
- tagParams:
-
The param values for template tags.
- recordId:
-
The record id of the master object you are creating emails from (e.g., for Sales Order ID 1, pass in 1).
Example
{
"subject": "string",
"body": "string",
"replyTo": "string",
"to": "string",
"cc": "string",
"bcc": "string",
"templateIds": [
"number"
],
"tagParams": [
{
"tag": "string",
"variables": "string"
}
],
"recordId": "number"
}
CreateErrorLogInput: object
The input variables for creating error logs.
- recordId:
-
The record related to this log.
- type:
-
The type of error log.
- body:
-
The stringified JSON of the errors array.
Example
{
"recordId": "number",
"type": "string",
"body": "string"
}
CreateExportInput: object
The input variables for creating exports.
- type:
-
The type of export.
- filter:
-
The JSON string of the filter for the relevant export type (e.g., { "createdAfter": "2020-01-01T00:00:00Z" }).
- skuLevelsFilter:
-
The JSON string of the sku levels filter for the SKU export type.
- stockLevelsFilter:
-
The JSON string of the stock levels filter for the SKU export type.
Example
{
"type": "string",
"filter": "string",
"skuLevelsFilter": "string",
"stockLevelsFilter": "string"
}
CreateFilterInput: object
The input variables for creating filters.
- name:
-
The name of the filter.
- color:
-
The color of the filter.
- module:
-
The module that the filter belongs to.
- queryParams:
-
The JSON string containing the query parameters belonging to this filter.
Example
{
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
CreateImportInput: object
The input variables for creating imports.
- type:
-
The type of import.
- file:
-
The CSV file to import.
- skipHeader:
-
Whether or not to skip the first line/header of the CSV in import.
- mappings:
-
The ordered array of mappings for the import, corresponding to the columns in the imported CSV. Skipped columns should be left blank (e.g., ["productId", "name", "code", ""]).
Example
{
"type": "string",
"file": "object",
"skipHeader": "boolean",
"mappings": [
"string"
]
}
CreateLabelInput: object
The input variables for creating labels.
- name:
-
The name of the label.
- color:
-
The color of the label. Defaults to #e6e6e6.
- modules:
-
The array of modules that this label will appear on.
Example
{
"name": "string",
"color": "string",
"modules": [
"string"
]
}
CreateLineItemInput: object
The input variables for creating line items.
- skuId:
-
The numerical ID of the SKU associated with this line item. Do not pass in a SKU if you wish to create a line item that does not track inventory.
- skuCostId:
-
The numerical ID of the Cost Rule associated with this line item. Either this field or skuPriceId are required if you are using a SKU.
- skuPriceId:
-
The numerical ID of the Price Rule associated with this line item. Either this field or skuCostId are required if you are using a SKU.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- defaultPrice:
-
The default price of the line item.
Example
{
"skuId": "number",
"skuCostId": "number",
"skuPriceId": "number",
"name": "string",
"description": "string",
"defaultPrice": "number"
}
CreateLotInput: object
The input variables for creating lots.
- skuId:
-
The numerical ID of the SKU associated with this lot.
- binId:
-
The numerical ID of the Bin Location associated with this lot.
- quantity:
-
The quantity of inventory within this lot (rounded to three decimal places).
- cost:
-
The cost per unit of inventory within the lot.
- lotNumber:
-
The identifier of the lot. If not provided, this will be randomly generated.
- altLotNumber:
-
The alternative identifier of the lot, for custom metadata.
- serialNumber:
-
The unique identifier of an individual piece of inventory.
- manufactureDate:
-
The date this piece of inventory was manufactured.
- expirationDate:
-
The date this piece of inventory expires.
Example
{
"skuId": "number",
"binId": "number",
"quantity": "number",
"cost": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object"
}
CreateNotificationInput: object
The input variables for creating notifications.
- message:
-
The text of the notification.
- userId:
-
The ID of the user to notify. Will default to the current user if not specified.
- type:
-
The type of notification.
- recordId:
-
The ID of the table record to reference in external links.
- hasBeenSeen:
-
The column indicating whether or not the notification has been seen.
Example
{
"message": "string",
"userId": "number",
"type": "string",
"recordId": "number",
"hasBeenSeen": "boolean"
}
CreatePriceRuleCriterionInput: object
The input variables for creating price rule criteria.
- skuPriceId:
-
The ID of the price rule.
- labelId:
-
The ID of the label to match against.
- matchCriteria:
-
The criteria for matching the provided labels to the criteria labels.
Example
{
"skuPriceId": "number",
"labelId": "number",
"matchCriteria": "string"
}
CreatePriceRuleInput: object
The input variables for creating price rules.
- skuId:
-
The numerical ID of the SKU associated with this price rule.
- unit:
-
The unit associated with this price (e.g., 'Pallet', 'Pack', 'Box')
- vendorPartNumber:
-
The vendor part number.
- quantity:
-
The quantity of units associated with this price.
- price:
-
The total price of the unit (e.g., 500.00 for $500/Pallet).
Example
{
"skuId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"price": "number"
}
CreateProductCategoryInput: object
The input variables for creating product categories.
- labelIds:
-
The array of Label IDs associated with this product category.
- subcategoryIds:
-
The array of Subcategory IDs associated with this product category.
- name:
-
The name of the product category.
- description:
-
The description of the product category.
- templateId:
-
The ID of the category template associated with this product category.
Example
{
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"subcategoryIds": [
{
"id": "number",
"remove": "boolean"
}
],
"name": "string",
"description": "string",
"templateId": "number"
}
CreateProductInput: object
The input variables for creating products.
- name:
-
The name of the product.
- displayId:
-
The alphanumeric ID that is displayed for this product.
- labelIds:
-
The array of Label IDs associated with this product.
- customFields:
-
The array of Custom Field keys and values associated with this product.
- description:
-
The description of the product.
- templateId:
-
The ID of the product template associated with this product.
Example
{
"name": "string",
"displayId": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"description": "string",
"templateId": "number"
}
CreatePurchaseOrderInput: object
The input variables for creating purchase orders.
- altId:
-
The alternative ID of the purchase order.
- warehouseId:
-
The numerical ID of the Warehouse associated with this purchase order.
- vendorId:
-
The numerical ID of the Vendor associated with this purchase order.
- statusId:
-
The numerical ID of the Status associated with this purchase order.
- notes:
-
The internal notes associated with this purchase order.
- externalNotes:
-
The notes intended for the vendor.
- issuedDate:
-
The date this purchase order was placed.
- dueDate:
-
The date that this purchase order is due.
- labelIds:
-
The array of Label IDs associated with this purchase order.
- customFields:
-
The array of Custom Field keys and values associated with this purchase order.
- lineItems:
-
The array of Line Items associated with this purchase order.
- receivements:
-
The array of Receivements associated with this purchase order.
- receipts:
-
The array of Receipts associated with this purchase order.
Example
{
"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",
"remove": "boolean"
}
]
}
CreateQuickBooksBillsInput: object
The input variables for upserting purchase order receipts to QuickBooks as bills.
- purchaseOrderIds:
-
The purchase order ids.
- expenseAccountId:
-
The Id of the QuickBooks expense account to use to fulfill this bill. If not specified, will default to Cost of Goods Sold account.
Example
{
"purchaseOrderIds": [
"number"
],
"expenseAccountId": "number"
}
CreateQuickBooksBillsPayload: object
The return type for the create QuickBooks bills mutation.
- success:
-
If this is set to true, it means the purchase orders receipts were successfully upserted as bills to QuickBooks.
Example
{
"success": "boolean"
}
CreateQuickBooksCustomersInput: object
The input variables for upserting customers to QuickBooks.
- customerIds:
-
The customer ids.
Example
{
"customerIds": [
"number"
]
}
CreateQuickBooksCustomersPayload: object
The return type for the create QuickBooks customers mutation.
- success:
-
If this is set to true, it means the customers were successfully upserted to QuickBooks.
Example
{
"success": "boolean"
}
CreateQuickBooksInvoicesInput: object
The input variables for upserting invoices to QuickBooks.
- salesOrderIds:
-
The sales order ids.
Example
{
"salesOrderIds": [
"number"
]
}
CreateQuickBooksInvoicesPayload: object
The return type for the create QuickBooks invoices mutation.
- success:
-
If this is set to true, it means the invoices were successfully upserted to QuickBooks.
Example
{
"success": "boolean"
}
CreateQuickBooksItemsInput: object
The input variables for upserting skus to QuickBooks as items.
- skuIds:
-
The sku ids.
Example
{
"skuIds": [
"number"
]
}
CreateQuickBooksItemsPayload: object
The return type for the create QuickBooks items mutation.
- success:
-
If this is set to true, it means the items were successfully upserted to QuickBooks.
Example
{
"success": "boolean"
}
CreateQuickBooksPurchaseOrdersInput: object
The input variables for upserting purchase orders to QuickBooks.
- purchaseOrderIds:
-
The purchase order ids.
Example
{
"purchaseOrderIds": [
"number"
]
}
CreateQuickBooksPurchaseOrdersPayload: object
The return type for the create QuickBooks purchase orders mutation.
- success:
-
If this is set to true, it means the purchase orders were successfully upserted to QuickBooks.
Example
{
"success": "boolean"
}
CreateQuickBooksVendorsInput: object
The input variables for upserting vendors to QuickBooks.
- vendorIds:
-
The vendor ids.
Example
{
"vendorIds": [
"number"
]
}
CreateQuickBooksVendorsPayload: object
The return type for the create QuickBooks vendors mutation.
- success:
-
If this is set to true, it means the vendors were successfully upserted to QuickBooks.
Example
{
"success": "boolean"
}
CreateSKUInput: object
The input variables for creating skus.
- isKit:
-
The flag for determining if the SKU is a kit or not.
- productId:
-
The numerical ID of the Product associated with this sku.
- code:
-
The identifier of the sku (UPC, GTIN, etc).
- name:
-
The display name of the sku.
- cost:
-
The default cost of the SKU.
- price:
-
The default price of the SKU.
- vendorId:
-
The primary Vendor ID associated with this sku. Required when passing in cost.
- vendorPartNumber:
-
The part number for the provided Vendor cost associated with this sku.
- vendorIds:
-
The array of Vendor IDs associated with this sku.
- labelIds:
-
The array of Label IDs associated with this sku.
- files:
-
The array of File Mappings associated with this sku.
- billOfMaterials:
-
The Bill of Materials consumed by assembly of this sku.
- customFields:
-
The array of Custom Field keys and values associated with this sku.
- minStockLevel:
-
The minimum stock level for this sku.
- maxStockLevel:
-
The maximum stock level for this sku.
Example
{
"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"
}
CreateSalesOrderInput: object
The input variables for creating sales orders.
- statusId:
-
The numerical ID of the Status associated with this sales order.
- originWarehouseId:
-
The numerical ID of the origin Warehouse associated with this sales order.
- altId:
-
The alternative ID of the sales order.
- customerId:
-
The Customer associated with this sales order.
- labelIds:
-
The array of Label IDs associated with this sales order.
- userIds:
-
The array of User IDs associated with this sales order.
- customFields:
-
The array of Custom Field keys and values associated with this sales order.
- lineItems:
-
The array of Line Items associated with this sales order.
- returns:
-
The Returns associated with this sales order.
- shipments:
-
The Shipments associated with this sales order.
- payments:
-
The Payments associated with this sales order.
- invoices:
-
The Invoices associated with this sales order.
- notes:
-
The internal notes on this sales order.
- externalNotes:
-
The external notes on this sales order.
- shipDate:
-
The date this order was shipped.
- cancelByDate:
-
The date that this order should be canceled by.
- customerPo:
-
The Customer PO Number.
- billingAddressId:
-
The numerical ID of the Billing Address.
- shippingAddressId:
-
The numerical ID of the Shipping Address.
- openDate:
-
The DateTime when the sales order was marked as placed.
Example
{
"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",
"shipDate": "string",
"packages": [
null
]
}
]
}
CreateTemplateInput: object
The input variables for creating templates.
- projectId:
-
The numerical ID of the Project associated with this template.
- isConsolidated:
-
The flag to determine whether or not this is a consolidated template.
- guestMode:
-
The flag to determine whether or not this template is publicly accessible in the storefront.
- fileName:
-
The file name.
- html:
-
The html of the template.
- type:
-
The template type.
- subtype:
-
The template subtype.
- files:
-
The array of File Mappings associated with this template.
Example
{
"projectId": "number",
"isConsolidated": "boolean",
"guestMode": "boolean",
"fileName": "string",
"html": "string",
"type": "string",
"subtype": "string",
"files": [
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
]
}
CreateTransferInput: object
The input variables for creating transfers.
- altId:
-
The alternative ID of the transfer.
- originWarehouseId:
-
The numerical ID of the origin Warehouse associated with this transfer.
- destinationWarehouseId:
-
The numerical ID of the origin Warehouse associated with this transfer.
- statusId:
-
The numerical ID of the Status associated with this transfer.
- notes:
-
The internal notes associated with this transfer.
- externalNotes:
-
The notes intended for the vendor.
- issuedDate:
-
The date this transfer was placed.
- dueDate:
-
The date that this transfer is due.
- labelIds:
-
The array of Label IDs associated with this transfer.
- customFields:
-
The array of Custom Field keys and values associated with this transfer.
- lineItems:
-
The array of Line Items associated with this transfer.
- receivements:
-
The array of Receivements associated with this transfer. Transfer receivements are associated with a single lot. If you create a receivement that encompases more than one lot, the API will automatically create multiple receivements.
Example
{
"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"
}
]
}
CreateUserInput: object
The input variables for creating users.
- username:
-
The name of the user.
- email:
-
The email address of the user.
- password:
-
The password for user authentication.
- roleSlug:
-
The slug for the user's role (e.g., admin).
- isActive:
-
The field indicating whether or not a user is active. A user cannot log in if they are inactive.
- profile:
-
The object containing all of the fields for a particular user's profile.
- labelIds:
-
The array of Label IDs associated with this user.
Example
{
"username": "string",
"email": "string",
"password": "string",
"roleSlug": "string",
"isActive": "boolean",
"profile": {
"firstName": "string",
"lastName": "string"
},
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
CreateUserRoleInput: object
The input variables for creating user roles.
- displayName:
-
The display name of the user role (e.g., Admin).
- slug:
-
The unique slug of the user role (e.g., admin). Will self-generate if left blank.
- routeBlacklist:
-
An array of routes to blacklist for this user role.
- scopeBlacklist:
-
An array of API scopes to blacklist for this user role.
Example
{
"displayName": "string",
"slug": "string",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
]
}
CreateVendorInput: object
The input variables for creating vendors.
- name:
-
The name of the vendor.
- contactIds:
-
The array of Contact IDs associated with this vendor.
- labelIds:
-
The array of Label IDs associated with this vendor.
- customFields:
-
The array of Custom Field keys and values associated with this vendor.
- addressIds:
-
The array of Address IDs associated with this vendor.
- skuIds:
-
The array of SKU IDs associated with this vendor.
Example
{
"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"
}
]
}
CreateWarehouseInput: object
The input variables for creating warehouses.
- name:
-
The name of the warehouse.
- contactIds:
-
The array of Contact IDs associated with this warehouse.
- labelIds:
-
The array of Label IDs associated with this warehouse.
- addressIds:
-
The array of Address IDs associated with this warehouse.
- customFields:
-
The array of Custom Field keys and values associated with this warehouse.
Example
{
"name": "string",
"contactIds": [
{
"id": "number",
"remove": "boolean"
}
],
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"addressIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
CreateWorkOrderInput: object
The input variables for creating work orders.
- altId:
-
The alternative ID of the work order.
- originWarehouseId:
-
The numerical ID of the Warehouse associated with this work order.
- statusId:
-
The numerical ID of the Status associated with this work order.
- notes:
-
The internal notes associated with this work order.
- externalNotes:
-
The notes intended for the vendor.
- labelIds:
-
The array of Label IDs associated with this work order.
- customFields:
-
The array of Custom Field keys and values associated with this work order.
- lineItems:
-
The array of Line Items associated with this work order.
- assemblies:
-
The array of Assemblies associated with this work order.
- startOn:
-
The date this work order was started.
- dueDate:
-
The date that this work order is due.
Example
{
"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"
}
CreateWorkflowActionInput: object
The input variables for creating workflow actions.
- workflowId:
-
The ID of the workflow.
- type:
-
The type of action.
- labelId:
-
The label id to apply for APPLY_LABEL and REMOVE_LABEL actions.
- emailSettings:
-
The configuration for SEND_EMAIL actions.
- purchaseOrderSettings:
-
The configuration for PURCHASE_ORDER actions.
Example
{
"workflowId": "number",
"type": "string",
"labelId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"purchaseOrderSettings": {
"warehouseId": "number",
"statusId": "number"
}
}
CreateWorkflowCriterionInput: object
The input variables for creating workflow criteria.
- workflowId:
-
The ID of the workflow.
- triggerCondition:
-
The condition for triggering the criterion.
- testTable:
-
The table being evaluated in the workflow trigger.
- testSubTable:
-
The subtable being evaluated in the workflow trigger.
- testColumn:
-
The column on the table being evaluated in the workflow trigger.
- testValue:
-
The test value being evaluated in the workflow trigger.
- testValueColumn:
-
The value of the test column being evaluated in the workflow trigger.
- useValueColumn:
-
The flag to determine whether or not 'testValue' or 'testValueColumn' is evaluated.
- compareLastValues:
-
The flag to determine whether or not to compare the last values from workflow evaluation. If these values are the same, the workflow will not trigger again.
- matchCriteria:
-
The criteria for matching the value to the indicated column.
Example
{
"workflowId": "number",
"triggerCondition": "string",
"testTable": "string",
"testSubTable": "string",
"testColumn": "string",
"testValue": "string",
"testValueColumn": "string",
"useValueColumn": "boolean",
"compareLastValues": "boolean",
"matchCriteria": "string"
}
CustomField: object
The object containing all of the fields for a particular custom field.
- id:
-
The numerical ID of the custom field.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this custom field.
- module:
-
The module that this custom field is available in.
- displayName:
-
The human-readable name of the custom field (e.g., 'Alternative Name').
- name:
-
The name of the custom field (alpha-numeric, underscore-delimeted, e.g., 'alternative_name').
- value:
-
The value of the custom field.
- sortOrder:
-
The numeric value you wish to sort by.
- createdAt:
-
The DateTime when the custom field was created.
- updatedAt:
-
The DateTime when the custom field was updated.
Example
{
"id": "number",
"accountId": "number",
"module": "string",
"displayName": "string",
"name": "string",
"value": "string",
"sortOrder": "number",
"createdAt": "string",
"updatedAt": "string"
}
CustomFieldInput: object
The input variables for attaching a custom field.
- id:
-
The numerical ID of the custom field.
- value:
-
The value of the custom field.
- remove:
-
If this is set to true, it will remove the custom field's value from the assigned object.
Example
{
"id": "number",
"value": "string",
"remove": "boolean"
}
CustomFieldModule: string
The options for custom field modules.
-
objectBIN_LOCATIONS
-
objectCUSTOMERS
-
objectDASHBOARDS
-
objectPRODUCTS
-
objectPURCHASE_ORDERS
-
objectSALES_ORDERS
-
objectSKUS
-
objectTRANSFERS
-
objectVENDORS
-
objectWAREHOUSES
-
objectWORK_ORDERS
CustomFieldPayload: object
The return type for custom field queries and mutations.
- customField:
-
The CustomField object.
Example
{
"customField": {
"id": "number",
"accountId": "number",
"module": "string",
"displayName": "string",
"name": "string",
"value": "string",
"sortOrder": "number",
"createdAt": "string",
"updatedAt": "string"
}
}
Customer: object
The object containing all of the fields for a particular customer.
- id:
-
The numerical ID of the customer.
- displayId:
-
The display ID of the customer.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this customer.
- altId:
-
The alternative ID of the customer.
- businessName:
-
The name of the customer.
- orders:
-
The Sales Orders associated with this customer.
- invoices:
-
The Invoices associated with this customer.
- amountDue:
-
The total amount due for all invoices on this customer.
- amountPaid:
-
The total amount paid for all invoices on this customer.
- total:
-
The total amount of all invoices on this customer.
- contacts:
-
The Contacts associated with this customer.
- addresses:
-
The Addresses associated with this customer.
- stripeId:
-
The CustomerId in Stripe associated with this customer.
- quickBooksId:
-
The CustomerId in QuickBooks associated with this customer.
- quickBooksSyncToken:
-
The SyncToken in QuickBooks associated with this customer.
- labels:
-
The Labels associated with this customer.
- customFields:
-
The array of Custom Fields associated with this customer.
- termId:
-
The numerical ID of the Term associated with this customer.
- taxExempt:
-
The field indicating whether or not the customer is exempt from sales tax.
- taxRate:
-
The tax rate (%) associated with this customer. Defaults to 0. Can be between 0 and 1 (0% - 100%).
- notes:
-
The notes on this customer.
- createdAt:
-
The DateTime when the customer was created.
- updatedAt:
-
The DateTime when the customer was updated.
Example
{
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"businessName": "string",
"orders": [
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
{
"id": "number",
"accountId": "number",
"module": "string"
}
]
}
}
]
}
CustomerPayload: object
The return type for customer queries and mutations.
- customer:
-
The Customer object.
Example
{
"customer": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"businessName": "string",
"orders": [
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
{
"id": "number",
"accountId": "number"
}
]
}
}
]
}
}
Date: object
A date string, such as 2007-12-03, compliant with the full-date format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
object
DateTime: object
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
object
DeleteImportExceptionPayload: object
- importException:
Example
{
"importException": {
"id": "number",
"shipStationOrderId": "string",
"data": "string"
}
}
DisconnectQuickBooksPayload: object
The return type for the disconnect from QuickBooks mutation.
- isActive:
-
If this is set to false, it means the account successfully disconnected QuickBooks.
Example
{
"isActive": "boolean"
}
Email: object
The object containing all of the fields for a particular email.
- subject:
-
The subject line of the sent email.
- html:
-
The html body of the sent email.
- replyTo:
-
The reply-to email address.
- to:
-
The recipient of the email.
- cc:
-
The carbon copy address of the email.
- bcc:
-
The blind carbon copy address of the email.
Example
{
"subject": "string",
"html": "string",
"replyTo": "string",
"to": "string",
"cc": "string",
"bcc": "string"
}
EmailJobInput: object
- tagParams:
-
The param values for template tags.
- recordId:
-
The record id of the master object you are creating emails from (e.g., for Sales Order ID 1, pass in 1).
- templateIds:
-
The ids of the templates you wish to append to the email body for this specific email job.
Example
{
"tagParams": [
{
"tag": "string",
"variables": "string"
}
],
"recordId": "number",
"templateIds": [
"number"
]
}
EmailPayload: object
The return type for email queries and mutations.
- email:
-
The Email object.
Example
{
"email": {
"subject": "string",
"html": "string",
"replyTo": "string",
"to": "string",
"cc": "string",
"bcc": "string"
}
}
EmailSettings: object
The object containing all of the fields for email workflow action configuration.
- templateId:
-
The id of the template to send.
- subject:
-
The subject line of the email.
- replyTo:
-
The reply to address.
- to:
-
The address to send the email to.
- bcc:
-
The bcc.
Example
{
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
}
EmailSettingsInput: object
The input variables for configuring email workflow actions.
- templateId:
-
The id of the template to send.
- subject:
-
The subject line of the email.
- replyTo:
-
The reply to address.
- to:
-
The address to send the email to.
- bcc:
-
The bcc.
Example
{
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
}
EnableStripeCustomerPayload: object
The object containing all of the fields for enabling certain Stripe features for a customer.
Example
{
"id": "number",
"idempotencyKey": "string",
"stripeId": "string"
}
ErrorLog: object
The object containing all of the fields for a particular error log.
Example
{
"id": "number",
"recordId": "number",
"type": "string",
"body": "string",
"createdAt": "string",
"updatedAt": "string"
}
ErrorLogPayload: object
The return type for error log queries and mutations.
- errorLog:
-
The Error Log object.
Example
{
"errorLog": {
"id": "number",
"recordId": "number",
"type": "string",
"body": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
ErrorLogType: string
The options for error logs.
-
objectIMPORT
-
objectBULK_UPDATE
-
objectBULK_DUPLICATE
Export: object
The object containing all of the fields for a particular export.
Example
{
"id": "number",
"type": "string",
"signedUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
ExportPayload: object
The return type for export queries and mutations.
- export:
-
The Export object.
Example
{
"export": {
"id": "number",
"type": "string",
"signedUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
ExportType: string
The options for exports.
-
objectCUSTOMERS
-
objectINVOICES
-
objectLOTS
-
objectPAYMENTS
-
objectPURCHASE_ORDERS
-
objectRECEIPTS
-
objectRECEIVEMENTS
-
objectRETURNS
-
objectSALES_ORDERS
-
objectSKUS
-
objectTRANSFERS
-
objectWORK_ORDERS
File: object
The object containing all of the fields for a particular file.
- id:
-
The numerical ID of the file.
- name:
-
The file name.
- type:
-
The file type.
- size:
-
The file size.
- path:
-
The file path.
- signedUrl:
-
The signed url of the file.
Example
{
"id": "number",
"name": "string",
"type": "string",
"size": "number",
"path": "string",
"signedUrl": "string"
}
FileMap: object
The object containing all of the fields for a particular file mapping.
- id:
-
The numerical ID of the file mapping.
- uploadId:
-
The numerical ID of the file upload.
- name:
-
The nickname of the file.
- sortOrder:
-
The numeric sort order of the file, used for e-commerce and templates.
- file:
-
The file associated with this mapping.
Example
{
"id": "number",
"uploadId": "number",
"name": "string",
"sortOrder": "number",
"file": {
"id": "number",
"name": "string",
"type": "string",
"size": "number",
"path": "string",
"signedUrl": "string"
}
}
FileMapInput: object
The input variables for attaching a file to a record.
- id:
-
The numerical ID of the File.
- name:
-
The nickname of the file. Will default to the name of the file.
- sortOrder:
-
The numeric sort order of the file, used for e-commerce and templates.
- remove:
-
If this is set to true, it will remove the file from the assigned object.
Example
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
Filter: object
The object containing all of the fields for a particular filter.
- id:
-
The numerical ID of the filter.
- userId:
-
The numerical ID of the User who created this filter.
- name:
-
The name of the filter.
- color:
-
The color of the filter.
- module:
-
The module that the filter belongs to.
- queryParams:
-
The JSON string containing the query parameters belonging to this filter.
Example
{
"id": "number",
"userId": "number",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
FilterAdjustmentInput: object
The input variables for filtering adjustment.
- skuId:
-
The query for filtering lots by SKU ID.
- skuIds:
-
The query for filtering lots by SKU IDs.
- warehouseId:
-
The query for filtering lots by Warehouse ID.
- warehouseIds:
-
The query for filtering lots by Warehouse IDs.
- createdAfter:
-
The filter for querying lots created after the provided DateTime.
- createdBefore:
-
The filter for querying lots created before the provided DateTime.
Example
{
"skuId": "number",
"skuIds": [
"number"
],
"warehouseId": "number",
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterBinLocationInput: object
The input variables for filtering bin locations.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a bin location by name.
- labelIds:
-
The array of Label IDs to filter on.
- warehouseIds:
-
The array of Warehouse IDs to filter on.
- createdAfter:
-
The filter for querying warehouses created after the provided DateTime.
- createdBefore:
-
The filter for querying warehouses created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterConsolidateSalesOrderInput: object
The input variables for filtering consolidated sales orders.
- ids:
-
The sales order IDs to filter on.
Example
{
"ids": [
"number"
]
}
FilterConsolidatedInvoiceInput: object
The input variables for filtering consolidated invoices.
- id:
-
The customer ID to filter on.
Example
{
"id": "number"
}
FilterConsolidatedReceivementInput: object
The input variables for filtering consolidated purchase order receivements.
- ids:
-
The purchase order IDs to filter on.
Example
{
"ids": [
"number"
]
}
FilterContactInput: object
The input variables for filtering contacts.
- searchText:
-
The query for searching for a contact by name or email.
Example
{
"searchText": "string"
}
FilterCostRuleInput: object
The input variables for filtering cost rules.
- skuIds:
-
The numerical IDs of the SKUs associated with this cost rule query.
- vendorIds:
-
The numerical IDs of the Vendors associated with this cost rule query.
- quantityGreaterThanOrEqualTo:
-
The filter for querying cost rules with a quantity greater than or equal to the value provided.
- quantityLessThanOrEqualTo:
-
The filter for querying cost rules with a quantity less than or equal to the value provided.
- quantityEquals:
-
The filter for querying cost rules with a quantity exactly equal to the value provided.
- createdAfter:
-
The filter for querying cost rules created after the provided DateTime.
- createdBefore:
-
The filter for querying cost rules created before the provided DateTime.
Example
{
"skuIds": [
"number"
],
"vendorIds": [
"number"
],
"quantityGreaterThanOrEqualTo": "number",
"quantityLessThanOrEqualTo": "number",
"quantityEquals": "number",
"createdAfter": "string",
"createdBefore": "string"
}
FilterCustomFieldInput: object
The input variables for filtering custom fields.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- createdAfter:
-
The filter for querying custom fields created after the provided DateTime.
- createdBefore:
-
The filter for querying custom fields created before the provided DateTime.
- searchText:
-
The filter for querying custom fields by name.
- modules:
-
The modules to fetch custom fields from.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string",
"modules": [
"string"
]
}
FilterCustomerInput: object
The input variables for filtering customers.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a customer by name.
- labelIds:
-
The array of Label IDs to filter on.
- createdAfter:
-
The filter for querying customers created after the provided DateTime.
- createdBefore:
-
The filter for querying customers created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterFilterInput: object
The input variables for filtering filters.
- module:
Example
{
"module": "string"
}
FilterHistoryInput: object
The input variables for filtering history records.
- table:
-
The table.
- userId:
-
The numerical ID of the User who invoked this action.
- recordId:
-
The numberical ID of the record associated with this action.
- createdAfter:
-
The filter for querying history records created after the provided DateTime.
- createdBefore:
-
The filter for querying history records created before the provided DateTime.
Example
{
"table": [
"string"
],
"userId": "number",
"recordId": "number",
"createdAfter": "string",
"createdBefore": "string"
}
FilterInvoiceInput: object
The input variables for filtering invoices.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- customerIds:
-
The filter for specifying one or many customers.
- isPaid:
-
The filter for searching for invoices that have been paid. A value of false will return invoices with a balance due.
- searchText:
-
The query for searching for an invoice.
- statusId:
-
The filter for querying invoices by status.
- createdAfter:
-
The filter for querying invoices created after the provided DateTime.
- createdBefore:
-
The filter for querying invoices created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"customerIds": [
"number"
],
"isPaid": "boolean",
"searchText": "string",
"statusId": "number",
"createdAfter": "string",
"createdBefore": "string"
}
FilterLabelInput: object
The input variables for filtering labels.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- createdAfter:
-
The filter for querying labels created after the provided DateTime.
- createdBefore:
-
The filter for querying labels created before the provided DateTime.
- searchText:
-
The filter for querying labels by name.
- modules:
-
The modules to fetch labels from.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string",
"modules": [
"string"
]
}
FilterLotInput: object
The input variables for filtering lots.
- searchText:
-
The query for searching for a lot.
- warehouseIds:
-
The query for filtering lots by Warehouse ID.
- skuId:
-
The query for filtering lots by SKU ID.
- skuIds:
-
The query for filtering lots by SKU IDs.
- ids:
-
The lot ids to filter on.
- excludeIds:
-
The lot ids to exclude in your query.
- manufacturedAfter:
-
The filter for querying lots manufactured after the provided DateTime.
- manufacturedBefore:
-
The filter for querying lots manufactured before the provided DateTime.
- expiredAfter:
-
The filter for querying lots expiring after the provided DateTime.
- expiredBefore:
-
The filter for querying lots expiring before the provided DateTime.
- createdAfter:
-
The filter for querying lots created after the provided DateTime.
- createdBefore:
-
The filter for querying lots created before the provided DateTime.
Example
{
"searchText": "string",
"warehouseIds": [
"number"
],
"skuId": "number",
"skuIds": [
"number"
],
"ids": [
"number"
],
"excludeIds": [
"number"
],
"manufacturedAfter": "object",
"manufacturedBefore": "object",
"expiredAfter": "object",
"expiredBefore": "object",
"createdAfter": "string",
"createdBefore": "string"
}
FilterLotsInput: object
The input variables for filtering lots.
- groupBy:
-
The filter for querying lots by type.
- idIn:
-
The filter for selecting records from the group by ID.
Example
{
"groupBy": "string",
"idIn": [
"number"
]
}
FilterModule: string
The modules filters are available on.
-
objectBIN_LOCATIONS
-
objectCALENDAR
-
objectCOGS
-
objectCOST_RULES
-
objectCUSTOM_FIELDS
-
objectCUSTOMERS
-
objectDASHBOARDS
-
objectGROSS_MARGIN
-
objectHISTORY
-
objectINVOICES
-
objectLABELS
-
objectLOTS
-
objectNOTIFICATIONS
-
objectPAYMENTS
-
objectPRICE_RULES
-
objectPRODUCTS
-
objectPURCHASE_ORDERS
-
objectRECEIPTS
-
objectRECEIVEMENTS
-
objectRETURNS
-
objectSALES_ORDERS
-
objectSHIPMENTS
-
objectSKU_VELOCITY
-
objectSKUS
-
objectSTOCK_HISTORY
-
objectTRANSFERS
-
objectUSERS
-
objectVENDORS
-
objectWAREHOUSES
-
objectWORK_ORDERS
-
objectWORKFLOWS
FilterNotificationInput: object
The input variables for filtering notifications.
Example
{
"hasBeenSeen": "boolean",
"createdAfter": "string",
"createdBefore": "string"
}
FilterPayload: object
The return type for filter queries and mutations.
- filter:
-
The Filter object.
Example
{
"filter": {
"id": "number",
"userId": "number",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
}
FilterPaymentInput: object
The input variables for filtering payments.
- searchText:
-
The query for searching for an payment.
- customerIds:
-
The filter for querying payment by customer ID.
- ids:
-
The ids to filter on.
- excludeIds:
-
The ids to exclude in your filter.
- source:
-
The filter for querying payments by source.
- createdAfter:
-
The filter for querying payments created after the provided DateTime.
- createdBefore:
-
The filter for querying payments created before the provided DateTime.
Example
{
"searchText": "string",
"customerIds": [
"number"
],
"ids": [
"number"
],
"excludeIds": [
"number"
],
"source": "string",
"createdAfter": "string",
"createdBefore": "string"
}
FilterPriceRuleInput: object
The input variables for filtering price rules.
- skuIds:
-
The numerical IDs of the SKUs associated with this price rule query.
- labelIds:
-
The customer label IDs to evaluate.
- quantityGreaterThanOrEqualTo:
-
The filter for querying prices rules with a quantity greater than or equal to the value provided.
- quantityLessThanOrEqualTo:
-
The filter for querying prices rules with a quantity less than or equal to the value provided.
- quantityEquals:
-
The filter for querying prices rules with a quantity exactly equal to the value provided.
- createdAfter:
-
The filter for querying price rules created after the provided DateTime.
- createdBefore:
-
The filter for querying price rules created before the provided DateTime.
Example
{
"skuIds": [
"number"
],
"labelIds": [
"number"
],
"quantityGreaterThanOrEqualTo": "number",
"quantityLessThanOrEqualTo": "number",
"quantityEquals": "number",
"createdAfter": "string",
"createdBefore": "string"
}
FilterProductCategoryInput: object
The input variables for filtering product categories.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a product category by name.
- labelIds:
-
The array of Label IDs to filter on.
- createdAfter:
-
The filter for querying products created after the provided DateTime.
- createdBefore:
-
The filter for querying products created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterProductInput: object
The input variables for filtering products.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a product by name or display id.
- labelIds:
-
The array of Label IDs to filter on.
- createdAfter:
-
The filter for querying products created after the provided DateTime.
- createdBefore:
-
The filter for querying products created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterProjectInput: object
The input variables for filtering projects.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a project by name or url.
- isActive:
-
Grab active projects.
- createdAfter:
-
The filter for querying projects created after the provided DateTime.
- createdBefore:
-
The filter for querying projects created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"isActive": "boolean",
"createdAfter": "string",
"createdBefore": "string"
}
FilterPurchaseOrderInput: object
The input variables for filtering purchase orders.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a purchase order by alt id.
- labelIds:
-
The array of Label IDs to filter on.
- skuIds:
-
The array of SKU IDs to filter on.
- warehouseIds:
-
The array of Warehouse IDs to filter on.
- vendorIds:
-
The array of Vendor IDs to filter on.
- statusIds:
-
The array of Status IDs to filter on.
- createdAfter:
-
The filter for querying purchase orders created after the provided DateTime.
- createdBefore:
-
The filter for querying purchase orders created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"vendorIds": [
"number"
],
"statusIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterReceiptInput: object
The input variables for filtering purchase order receipts.
- searchText:
-
The filter for searching for receipts.
- statusId:
-
The filter for querying for receipts by status.
- ids:
-
The ids to query on.
- excludeIds:
-
The ids to ignore when filtering.
- dueAfter:
-
The filter for querying purchase order receipts due after the provided DateTime.
- dueBefore:
-
The filter for querying purchase order receipts due before the provided DateTime.
- createdAfter:
-
The filter for querying purchase order receipts created after the provided DateTime.
- createdBefore:
-
The filter for querying purchase order receipts created before the provided DateTime.
Example
{
"searchText": "string",
"statusId": "number",
"ids": [
"number"
],
"excludeIds": [
"number"
],
"dueAfter": "object",
"dueBefore": "object",
"createdAfter": "string",
"createdBefore": "string"
}
FilterReceivementInput: object
The input variables for filtering purchase order receipts.
- searchText:
-
The filter for searching for purchase order receivements.
- binId:
-
The filter for querying for receivements by bin ID.
- ids:
-
The ids to filter on.
- excludeIds:
-
The ids to exclude from your filter.
- expiredAfter:
-
The filter for querying purchase order receivements expired after the provided DateTime.
- expiredBefore:
-
The filter for querying purchase order receivements expired before the provided DateTime.
- createdAfter:
-
The filter for querying purchase order receivements created after the provided DateTime.
- createdBefore:
-
The filter for querying purchase order receivements created before the provided DateTime.
Example
{
"searchText": "string",
"binId": "number",
"ids": [
"number"
],
"excludeIds": [
"number"
],
"expiredAfter": "object",
"expiredBefore": "object",
"createdAfter": "string",
"createdBefore": "string"
}
FilterSKUInput: object
The input variables for filtering skus.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- belowMinStockLevel:
-
The filter for selecting skus whose stock available is below the given minimum stock level.
- searchText:
-
The query for searching for a sku by name.
- labelIds:
-
The array of Label IDs to filter on.
- vendorIds:
-
The array of Vendor IDs to filter on.
- createdAfter:
-
The filter for querying skus created after the provided DateTime.
- createdBefore:
-
The filter for querying skus created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"belowMinStockLevel": "boolean",
"searchText": "string",
"labelIds": [
"number"
],
"vendorIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterSKULevelsInput: object
The input variables for filtering sku levels.
- type:
Example
{
"type": "string"
}
FilterSKUVelocityInput: object
The filters for the SKU Velocity Report.
- skuIds:
-
The SKU IDs to evaluate.
- warehouseIds:
-
Will return values only from the given warehouses.
- labelIds:
-
The SKU labels to filter on.
- createdAfter:
-
The filter for querying sku velocity values recorded after the provided DateTime.
- createdBefore:
-
The filter for querying sku velocity values recorded before the provided DateTime.
Example
{
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterSalesOrderInput: object
The input variables for filtering sales orders.
- ids:
-
The IDs to filter on.
- lotIds:
-
The lot IDs to filter on. On line item lot queries, this will only return the passed lots.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a sales order by name.
- labelIds:
-
The array of Label IDs to filter on.
- userIds:
-
The array of User IDs to filter on.
- skuIds:
-
The array of SKU IDs to filter on.
- warehouseIds:
-
The array of Warehouse IDs to filter on.
- statusIds:
-
The array of Status IDs to filter on.
- customerIds:
-
The array of Customer IDs to filter on.
- createdAfter:
-
The filter for querying sales orders created after the provided DateTime.
- createdBefore:
-
The filter for querying sales orders created before the provided DateTime.
Example
{
"ids": [
"number"
],
"lotIds": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"userIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"statusIds": [
"number"
],
"customerIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterShipmentInput: object
The input variables for filtering shipments.
- searchText:
-
The query for searching for a sales order by sales order ID, sales order display ID, package ID, or shipment ID.
- warehouseIds:
-
The warehouse IDs to filter on.
- customerIds:
-
The customer IDs to filter on.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- isShipped:
-
The filter to return shipments that have been fully or partially shipped.
- salesOrderIDs:
-
The filter for selecting shipments for the provided sales orders.
- packageIds:
-
The filter for selecting shipments for the provided packages.
- excludePackageIds:
-
The filter for excluding shipments for the provided packages.
- createdAfter:
-
The filter for querying shipments created after the provided DateTime.
- createdBefore:
-
The filter for querying shipments created before the provided DateTime.
Example
{
"searchText": "string",
"warehouseIds": [
"number"
],
"customerIds": [
"number"
],
"ids": [
"number"
],
"excludeIds": [
"number"
],
"isShipped": "boolean",
"salesOrderIDs": [
"number"
],
"packageIds": [
"number"
],
"excludePackageIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterShipmentReturnInput: object
The input variables for filtering shipment returns.
- searchText:
-
The query for searching for a shipment return.
- warehouseId:
-
The filter for querying returns by their return warehouse ID.
- warehouseIds:
-
The filter for querying returns by their return warehouse IDs.
- customerIds:
-
The filter for querying returns by their customer IDs.
- ids:
-
The ids to filter on.
- excludeIds:
-
The ids to exclude from your filter.
- isReturned:
-
The filter for querying for returns that are partially or fully processed.
- createdAfter:
-
The filter for querying returns created after the provided DateTime.
- createdBefore:
-
The filter for querying returns created before the provided DateTime.
Example
{
"searchText": "string",
"warehouseId": "number",
"warehouseIds": [
"number"
],
"customerIds": [
"number"
],
"ids": [
"number"
],
"excludeIds": [
"number"
],
"isReturned": "boolean",
"createdAfter": "string",
"createdBefore": "string"
}
FilterStatusInput: object
The input variables for filtering statuses.
- module:
Example
{
"module": [
"string"
]
}
FilterStockHistoryInput: object
The input variables for filtering stock history.
Example
{
"warehouseIds": [
"number"
],
"type": "string",
"createdAfter": "string",
"createdBefore": "string"
}
FilterStockLevelsInput: object
The input variables for filtering sku stock levels.
- groupBy:
-
The filter for querying stock levels by type.
- idIn:
-
The filter for selecting records from the group by ID.
Example
{
"groupBy": "string",
"idIn": [
"number"
]
}
FilterTemplateInput: object
The input variables for filtering templates.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a template by name or template html.
- labelIds:
-
The array of Label IDs to filter on.
- type:
-
The template type.
- subtype:
-
The template subtype.
- subtypes:
-
Multiple template subtypes to filter on.
- createdAfter:
-
The filter for querying templates created after the provided DateTime.
- createdBefore:
-
The filter for querying templates created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"type": "string",
"subtype": "string",
"subtypes": [
"string"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterTransferInput: object
The input variables for filtering transfers.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a transfer by alt id.
- labelIds:
-
The array of Label IDs to filter on.
- statusIds:
-
The array of Status IDs to filter on.
- skuIds:
-
The array of SKU IDs to filter on.
- warehouseIds:
-
The array of Warehouse IDs to filter on.
- createdAfter:
-
The filter for querying transfers created after the provided DateTime.
- createdBefore:
-
The filter for querying transfers created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"statusIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterUserInput: object
The input variables for filtering users.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching through user text fields.
- roles:
-
The array of the user role slugs to filter on (e.g., admin).
- labelIds:
-
The array of Label IDs to filter on.
- isActive:
-
Filter active users.
- isInactive:
-
Filter inactive users.
- createdAfter:
-
The filter for querying users created after the provided DateTime.
- createdBefore:
-
The filter for querying users created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"roles": [
"string"
],
"labelIds": [
"number"
],
"isActive": "boolean",
"isInactive": "boolean",
"createdAfter": "string",
"createdBefore": "string"
}
FilterUserRoleInput: object
The input variables for filtering user roles.
- searchText:
-
The query for searching for user role by name.
Example
{
"searchText": "string"
}
FilterVendorInput: object
The input variables for filtering vendors.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a vendor by name.
- labelIds:
-
The array of Label IDs to filter on.
- createdAfter:
-
The filter for querying vendors created after the provided DateTime.
- createdBefore:
-
The filter for querying vendors created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterWarehouseInput: object
The input variables for filtering warehouses.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a warehouse by name.
- labelIds:
-
The array of Label IDs to filter on.
- createdAfter:
-
The filter for querying warehouses created after the provided DateTime.
- createdBefore:
-
The filter for querying warehouses created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterWorkOrderInput: object
The input variables for filtering work orders.
- ids:
-
The IDs to filter on.
- excludeIds:
-
The IDs to exclude.
- searchText:
-
The query for searching for a work order by alt id or display id.
- labelIds:
-
The array of Label IDs to filter on.
- statusIds:
-
The array of Status IDs to filter on.
- skuIds:
-
The array of SKU IDs to filter on.
- warehouseIds:
-
The array of Warehouse IDs to filter on.
- createdAfter:
-
The filter for querying work orders created after the provided DateTime.
- createdBefore:
-
The filter for querying work orders created before the provided DateTime.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"searchText": "string",
"labelIds": [
"number"
],
"statusIds": [
"number"
],
"skuIds": [
"number"
],
"warehouseIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string"
}
FilterWorkflowInput: object
The input variables for filtering workflows.
Example
{
"ids": [
"number"
],
"excludeIds": [
"number"
],
"createdAfter": "string",
"createdBefore": "string",
"searchText": "string"
}
Float: number
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
number
GetCarriersPayload: object
- carriers:
Example
{
"carriers": [
{
"name": "string",
"code": "string",
"accountNumber": "string",
"requiresFundedAccount": "boolean",
"balance": "number",
"nickname": "string",
"shippingProviderId": "number",
"primary": "boolean"
}
]
}
GetRatesInput: object
The variables for pulling rates from ShipStation.
- carrierCode:
-
The carrier code to pull rates for.
- weight:
-
The weight of the package in ounces.
- length:
-
The length of the package in inches.
- width:
-
The width of the package in inches.
- height:
-
The height of the package in inches.
- salesOrderId:
-
The ID of the Sales Order that the package belongs to. If this is provided, fromPostalCode, toState, toCountry, toPostalCode, and toCity will be ignored, and the values from the Sales Order will be used instead.
- fromPostalCode:
-
The postal code of the origin warehouse (required if no salesOrderId provided).
- toState:
-
The destination state abbreviation (required if no salesOrderId provided).
- toCountry:
-
The destination country code (required if no salesOrderId provided).
- toPostalCode:
-
The destination postal code (required if no salesOrderId provided).
- toCity:
-
The destination city (required if no salesOrderId provided).
Example
{
"carrierCode": "string",
"weight": "number",
"length": "number",
"width": "number",
"height": "number",
"salesOrderId": "number",
"fromPostalCode": "string",
"toState": "string",
"toCountry": "string",
"toPostalCode": "string",
"toCity": "string"
}
GetRatesPayload: object
- rates:
Example
{
"rates": [
{
"carrierCode": "string",
"serviceName": "string",
"serviceCode": "string",
"shipmentCost": "number",
"otherCost": "number"
}
]
}
HistoryPayload: object
The return type for history queries.
- historyRecord:
-
The History Record object.
Example
{
"historyRecord": {
"id": "number",
"accountId": "number",
"userId": "number",
"actionId": "string",
"tableId": "string",
"recordId": "number",
"description": "string",
"metadata": "string",
"createdAt": "string"
}
}
HistoryRecord: object
The object containing all of the fields for a particular history record.
- id:
-
The numerical ID of the history record.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this history record.
- userId:
-
The numerical ID of the User who invoked this action.
- actionId:
-
The unique identifier for the invoked action.
- tableId:
-
The table performed on.
- recordId:
-
The numerical ID of the updated record on the associated table.
- description:
-
The summary of the action invoked.
- metadata:
-
The fields that were changed by this action.
- createdAt:
-
The DateTime when the action was invoked.
Example
{
"id": "number",
"accountId": "number",
"userId": "number",
"actionId": "string",
"tableId": "string",
"recordId": "number",
"description": "string",
"metadata": "string",
"createdAt": "string"
}
HistoryTables: string
The options for filtering history records by table.
-
objectADDRESSES
-
objectUSERS
-
objectUSER_ROLES
-
objectPRODUCTS
-
objectVENDORS
-
objectWAREHOUSES
-
objectLABELS
-
objectCUSTOM_FIELDS
-
objectPURCHASE_ORDERS
-
objectSKUS
-
objectTRANSFERS
-
objectSALES_ORDERS
Import: object
The object containing all of the fields for a particular import.
Example
{
"id": "number",
"type": "string",
"signedUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
ImportPayload: object
The return type for import queries and mutations.
- import:
-
The Import object.
Example
{
"import": {
"id": "number",
"type": "string",
"signedUrl": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
Int: number
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
number
InternalLineItem: object
The object containing all of the fields for a particular line item on internal processes.
- id:
-
The numerical ID of the Line Item.
- skuId:
-
The numerical ID of the SKU associated with this line item.
- quantity:
-
The quantity being processed.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- lots:
-
The array of Lots consumed by this line item.
- lotMappings:
-
The array of Lot Maps awaiting transfer.
Example
{
"id": "number",
"skuId": "number",
"quantity": "number",
"name": "string",
"description": "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": [
{
"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"
}
]
}
]
}
InternalLineItemInput: object
The input variables for creating line items on internal processes.
- id:
-
The numerical ID of the Line Item.
- 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 processed.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- remove:
-
If this is set to true, it will remove the line item from the assigned object.
Example
{
"id": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
Invoice: object
The object containing all of the fields for a particular invoice.
- id:
-
The numerical ID of the invoice.
- salesOrderId:
-
The numerical ID of the sales order associated with this invoice.
- salesOrder:
-
The Sales Order associated with this invoice.
- customer:
-
The Customer associated with this invoice.
- salesOrderDisplayId:
-
The display ID of the sales order.
- altId:
-
The alternative ID.
- statusId:
-
The numerical ID of the Payment Status.
- statusName:
-
The name of the status.
- billingAddressId:
-
The numerical ID of the Billing Address.
- billingAddress:
-
The full address object of the billing address.
- shippingAddressId:
-
The numerical ID of the Shipping Address.
- shippingAddress:
-
The full address object of the shipping address.
- notes:
-
The notes for the invoice.
- payments:
-
The Payments associated with this invoice.
- amountDue:
-
The amount due on this invoice.
- amountPaid:
-
The amount paid to this invoice.
- total:
-
The total amount of the invoice.
- dueDate:
-
The due date
- lineItems:
-
The Line Items associated with this invoice.
- quickBooksId:
-
The QuickBooks ID associated with this invoice.
- quickBooksSyncToken:
-
The QuickBooks sync token associated with this invoice.
- createdAt:
-
The DateTime when the invoice was created.
- updatedAt:
-
The DateTime when the invoice was updated.
Example
{
"id": "number",
"salesOrderId": "number",
"salesOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
]
}
}
}
InvoiceInput: object
The input variables for sales order payment.
- id:
-
The numerical ID of the invoice. Used for updates
- altId:
-
The alternative ID.
- statusId:
-
The numerical ID of the Payment Status.
- billingAddressId:
-
The numerical ID of the Billing Address.
- shippingAddressId:
-
The numerical ID of the Shipping Address.
- notes:
-
The notes for the invoice.
- payments:
-
The array of Payment IDs to apply to this invoice.
- lineItems:
-
The Line Items associated with this invoice.
- dueDate:
-
The due date.
- remove:
-
If this is set to true, it will remove the payment from the order and any assigned invoices.
Example
{
"id": "number",
"altId": "string",
"statusId": "number",
"billingAddressId": "number",
"shippingAddressId": "number",
"notes": "string",
"payments": [
{
"id": "number",
"remove": "boolean"
}
],
"lineItems": [
{
"lineItemId": "number",
"quantity": "number",
"price": "number",
"remove": "boolean"
}
],
"dueDate": "object",
"remove": "boolean"
}
InvoiceLineItemInput: object
The input variables for invoice line items.
- lineItemId:
-
The numerical ID of the Line Item.
- quantity:
-
The units of inventory being invoiced.
- price:
-
The unit price of the item on this invoice.
- remove:
-
If this is set to true, it will remove the item from the invoice.
Example
{
"lineItemId": "number",
"quantity": "number",
"price": "number",
"remove": "boolean"
}
InvoiceLineItems: object
The object containing all of the fields for a particular invoice line item.
- lineItemId:
-
The numerical ID of the Line Item.
- name:
-
The name of the SKU.
- description:
-
The description of the SKU.
- quantity:
-
The units of inventory being invoiced.
- price:
-
The unit price of the item on this invoice.
- total:
-
The total price of the item on this invoice.
- remove:
-
If this is set to true, it will remove the item from the invoice.
Example
{
"lineItemId": "number",
"name": "string",
"description": "string",
"quantity": "number",
"price": "number",
"total": "number",
"remove": "boolean"
}
Label: object
The object containing all of the fields for a particular label.
- id:
-
The numerical ID of the label.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this label.
- name:
-
The name of the label.
- color:
-
The color of the label.
- modules:
-
The modules this label belongs to.
- createdAt:
-
The DateTime when the label was created.
- updatedAt:
-
The DateTime when the label was updated.
Example
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
LabelModule: string
The options for label modules.
-
objectBIN_LOCATIONS
-
objectCUSTOMERS
-
objectDASHBOARDS
-
objectPRICE_RULES
-
objectPRODUCTS
-
objectPURCHASE_ORDERS
-
objectSALES_ORDERS
-
objectSKUS
-
objectTRANSFERS
-
objectUSERS
-
objectVENDORS
-
objectWAREHOUSES
-
objectWORK_ORDERS
LabelPayload: object
The return type for label queries and mutations.
- label:
-
The Label object.
Example
{
"label": {
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
}
LineItem: object
The object containing all of the fields for a particular line item.
- id:
-
The numerical ID of the line item.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this sku.
- skuId:
-
The numerical ID of the SKU associated with this line item. Do not pass in a SKU if you wish to create a line item that does not track inventory.
- quantity:
-
The quantity mapped on a specific process.
- skuCostId:
-
The numerical ID of the Cost Rule associated with this line item. Either this field or skuPriceId are required if you are using a SKU.
- skuPriceId:
-
The numerical ID of the Price Rule associated with this line item. Either this field or skuCostId are required if you are using a SKU.
- defaultPrice:
-
The default price of the line item.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
Example
{
"id": "number",
"accountId": "number",
"skuId": "number",
"quantity": "number",
"skuCostId": "number",
"skuPriceId": "number",
"defaultPrice": "number",
"name": "string",
"description": "string"
}
LineItemPayload: object
The return type for line item queries and mutations.
- lineItem:
-
The Line Item object.
Example
{
"lineItem": {
"id": "number",
"accountId": "number",
"skuId": "number",
"quantity": "number",
"skuCostId": "number",
"skuPriceId": "number",
"defaultPrice": "number",
"name": "string",
"description": "string"
}
}
Lot: object
The object containing all of the fields for a particular lot.
- id:
-
The numerical ID of the lot.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this lot.
- skuId:
-
The numerical ID of the SKU associated with this lot.
- skuCode:
-
The code of the associated SKU.
- skuName:
-
The name of the SKU.
- binId:
-
The numerical ID of the Bin Location associated with this lot.
- binName:
-
The name of the Bin Location associated with this lot.
- name:
-
The name of the line item.
- description:
-
The description of the line item.
- quantity:
-
The quantity of inventory within this lot.
- originalQuantity:
-
The original quantity of the lot.
- quantityAllocated:
-
The quantity of inventory allocated from this lot.
- quantityCommitted:
-
The quantity of inventory committed from this lot.
- cost:
-
The cost per unit of inventory within the lot.
- quantityMapped:
-
The quantity mapped on a particular process (e.g., Transfers, Work Orders, Sales Orders). Only applicable on those processes.
- quantityReceived:
-
The quantity received or released on a particular process (e.g., Transfers, Work Orders, Sales Orders). Only applicable on those processes.
- lotNumber:
-
The identifier of the lot.
- altLotNumber:
-
The alternative identifier of the lot, for custom metadata.
- serialNumber:
-
The unique identifier of an individual piece of inventory.
- salesOrderId:
-
The numerical ID of the SalesOrder this lot is assigned to (available on only certain queries).
- salesOrderDisplayId:
-
The display ID of the SalesOrder this lot is assigned to (available on only certain queries).
- workOrderAssemblyId:
-
The id of the assembly used to create this lot if a work order was involved in its creation.
- workOrderId:
-
The id of the work order used to create this lot if a work order was involved in its creation.
- workOrderBOMCOGS:
-
The cost of lots of the bill of materials used to create this lot if a work order was involved in its creation.
- workOrderBOMLots:
-
The lots of the bill of materials used to create this lot if a work order was involved in its creation.
- manufactureDate:
-
The date this piece of inventory was manufactured.
- expirationDate:
-
The date this piece of inventory expires.
- totalValue:
-
The current value of the lot.
- createdAt:
-
The DateTime when the lot was created.
- updatedAt:
-
The DateTime when the lot was updated.
Example
{
"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",
"salesOrderDisplayId": "number",
"workOrderAssemblyId": "number",
"workOrderId": "number",
"workOrderBOMCOGS": "number"
}
]
}
LotInput: object
The input variables for mapping lots to inventory processes.
- id:
-
The numerical ID of the Lot.
- quantity:
-
The quantity you want to pull from this specific lot.
- remove:
-
If this is set to true, it will remove the mapped lot.
Example
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
LotPayload: object
The return type for lot queries and mutations.
- lot:
-
The Lot object.
Example
{
"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",
"salesOrderDisplayId": "number",
"workOrderAssemblyId": "number",
"workOrderId": "number"
}
]
}
}
Module: object
The return type for module queries.
- id:
- name:
- graphqlEnum:
- table:
- allScopes:
- scopes:
Example
{
"id": "string",
"name": "string",
"graphqlEnum": "string",
"table": "string",
"allScopes": [
"string"
],
"scopes": {
"read": [
{
"name": "string",
"id": "string"
}
],
"write": [
{
"name": "string",
"id": "string"
}
]
}
}
Notification: object
The object containing all of the fields for a particular notification.
- id:
-
The numerical ID of the notification.
- message:
-
The text of the notification.
- type:
-
The type of notification.
- recordId:
-
The ID of the table record to reference in external links.
- hasBeenSeen:
-
The column indicating whether or not the notification has been seen.
- createdAt:
-
The DateTime when the export was created.
- updatedAt:
-
The DateTime when the export was updated.
Example
{
"id": "number",
"message": "string",
"type": "string",
"recordId": "number",
"hasBeenSeen": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
NotificationPayload: object
The return type for notification queries and mutations.
- notification:
-
The Notification object.
Example
{
"notification": {
"id": "number",
"message": "string",
"type": "string",
"recordId": "number",
"hasBeenSeen": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
}
NotificationType: string
The options for notification types.
-
objectGENERIC
-
A generic notification. Can be used for anything.
-
objectEXPORT
-
A notification generated when an export is complete.
-
objectIMPORT
-
A notification generated when an import is complete.
-
objectBULK_UPDATE
-
A notification generated when a bulk update is complete.
-
objectBULK_DUPLICATE
-
A notification generated when a bulk duplication is complete.
-
objectEMAIL
-
A notification generated when a bulk email is complete.
-
objectSALES_ORDER_BULK_ACTION
-
A notification generated when a sales order bulk action is complete.
-
objectSKU_BULK_ACTION
-
A notification generated when a sku bulk action is complete.
-
objectQUICK_BOOKS
-
A notification generated when a QuickBooks sync is complete.
Order: object
- salesOrderId:
- shipmentId:
- packageId:
- shipStationOrderId:
- shipStationOrderKey:
- shipStationOrderNumber:
- error:
Example
{
"salesOrderId": "number",
"shipmentId": "number",
"packageId": "number",
"shipStationOrderId": "string",
"shipStationOrderKey": "string",
"shipStationOrderNumber": "string",
"error": "string"
}
Package: object
The object containing all of the fields for a particular package.
- id:
-
The numerical ID of the package.
- trackingNumber:
-
The tracking number of the package.
- items:
-
The Package Items associated with this package.
- billingAddressId:
-
The numerical ID of the Billing Address. This will default to the address on the sales order if not specified.
- billingAddress:
-
The Billing Address of the package. This will default to the address on the sales order if not specified.
- shippingAddressId:
-
The numerical ID of the Shipping Address. This will default to the address on the sales order if not specified.
- shippingAddress:
-
The Shipping Address of the package. This will default to the address on the sales order if not specified.
- shipStationOrderId:
-
The orderId of the associated Order on ShipStation.
Example
{
"id": "number",
"trackingNumber": "string",
"items": [
{
"id": "number",
"packageItemId": "number",
"lineItemId": "number",
"name": "string",
"description": "string",
"binId": "number",
"quantity": "number",
"quantityShipped": "number",
"quantityPendingReturn": "number",
"quantityReturned": "number"
}
],
"billingAddressId": "number",
"billingAddress": {
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
},
"shippingAddressId": "number",
"shippingAddress": {
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
},
"shipStationOrderId": "string"
}
PackageInput: object
The input variables for creating a package.
- id:
-
The numerical ID of the package. Required for updating.
- trackingNumber:
-
The tracking number of the package.
- items:
- billingAddressId:
-
The numerical ID of the Billing Address. This will default to the address on the sales order if not specified.
- shippingAddressId:
-
The numerical ID of the Shipping Address. This will default to the address on the sales order if not specified.
- remove:
-
If this is set to true, it will remove the package from the shipment.
Example
{
"id": "number",
"trackingNumber": "string",
"items": [
{
"id": "number",
"lineItemId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"remove": "boolean"
}
],
"billingAddressId": "number",
"shippingAddressId": "number",
"remove": "boolean"
}
PackageItem: object
The object containing all of the fields for a particular package item.
- id:
-
The numerical ID of the package item.
- packageItemId:
-
The numerical ID of the package item.
- lineItemId:
-
The numerical ID of the Line Item being received.
- name:
-
The code of the SKU associated with this line item.
- description:
-
The description of the SKU associated with this line item.
- binId:
-
The numerical ID of the return's Bin Location.
- quantity:
-
The quantity to ship.
- quantityShipped:
-
The quantity shipped.
- quantityPendingReturn:
-
The quantity pending return.
- quantityReturned:
-
The quantity returned.
Example
{
"id": "number",
"packageItemId": "number",
"lineItemId": "number",
"name": "string",
"description": "string",
"binId": "number",
"quantity": "number",
"quantityShipped": "number",
"quantityPendingReturn": "number",
"quantityReturned": "number"
}
PackageItemInput: object
The input variables for creating a package item.
- id:
-
The numerical ID of the package item. Required for updating.
- lineItemId:
-
The numerical ID of the Line Item being received.
- 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 to ship.
- remove:
-
If this is set to true, it will remove the item from the package.
Example
{
"id": "number",
"lineItemId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"remove": "boolean"
}
PackageItemReturnInput: object
The input variables for creating a package item return.
- id:
-
The numerical ID of the package item.
- warehouseId:
-
The numerical ID of the Warehouse you wish to return inventory to.
- binId:
-
The numerical ID of the Bin you wish to return inventory to. If this is not set, then the oldest bin for the respective warehouse will be chosen automatically, or a new one will be generated if no bins exist. This field only applies when returning to a warehouse other than the original warehouse the item was shipped from.
- quantity:
-
The quantity to return.
- remove:
-
If this is set to true, it will remove the package from the shipment.
Example
{
"id": "number",
"warehouseId": "number",
"binId": "number",
"quantity": "number",
"remove": "boolean"
}
Payment: object
The object containing all of the fields for a particular payment.
- id:
-
The numerical ID of the payment.
- salesOrderId:
-
The numerical ID of the sales order associated with this payment.
- salesOrderDisplayId:
-
The display ID of the sales order associated with this payment.
- customer:
-
The Customer associated with this payment.
- altId:
-
The alternative ID.
- checkNumber:
-
The number of the check used if the payment source is CHECK.
- amount:
-
The amount paid.
- paymentDate:
-
The date the payment was processed.
- notes:
-
The notes for the payment.
- source:
-
The payment source.
- billingAddressId:
-
The numerical ID of the Billing Address
- billingAddress:
-
The Billing Address.
- invoices:
-
The Invoices associated with this payment.
- createdAt:
-
The DateTime when the payment was created.
- updatedAt:
-
The DateTime when the payment was updated.
Example
{
"id": "number",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"customer": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"businessName": "string",
"orders": [
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
null
]
}
}
]
}
}
PaymentInput: object
The input variables for sales order payment.
- id:
-
The numerical ID of the payment. Used for updates
- altId:
-
The alternative ID.
- checkNumber:
-
The number of the check used if the payment source is CHECK.
- amount:
-
The amount paid.
- paymentDate:
-
The date the payment was processed.
- notes:
-
The notes for the payment.
- source:
-
The payment source.
- billingAddressId:
-
The numerical ID of the Billing Address
- invoices:
-
The array of Invoice IDs to apply this payment to.
- remove:
-
If this is set to true, it will remove the payment from the order and any assigned invoices.
Example
{
"id": "number",
"altId": "string",
"checkNumber": "string",
"amount": "number",
"paymentDate": "object",
"notes": "string",
"source": "string",
"billingAddressId": "number",
"invoices": [
{
"id": "number",
"remove": "boolean"
}
],
"remove": "boolean"
}
PaymentSource: string
The options for payment methods.
-
objectCASH
-
objectCHECK
-
objectWIRE
-
objectPAYPAL
-
objectAUTHORIZE_NET
-
objectSTRIPE
-
objectSTRIPE_ACH
-
objectSTRIPE_CARD_ON_FILE
-
objectCARD_ON_FILE
-
objectOTHER
PaymentsData: object
- totalAmount:
- payments:
Example
{
"totalAmount": "number",
"payments": [
{
"source": "string",
"amount": "number"
}
]
}
PriceRule: object
The object containing all of the fields for a particular price rule.
- id:
-
The numerical ID of the price rule.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this price.
- skuId:
-
The numerical ID of the SKU associated with this price.
- skuName:
-
The description of the SKU associated with this price.
- skuCode:
-
The code of the SKU associated with this price.
- quantity:
-
The quantity of units associated with this price.
- price:
-
The total price of the unit (e.g., 500.00 for $500/Pallet).
- unit:
-
The unit associated with this cost (e.g., 'Pallet', 'Pack', 'Box')
- criteria:
-
The criteria associated with this price rule.
- createdAt:
-
The DateTime when the price rule was created.
Example
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"price": "number",
"unit": "string",
"criteria": [
{
"id": "number",
"skuPriceId": "number",
"labelId": "number",
"matchCriteria": "string"
}
],
"createdAt": "string"
}
PriceRuleCriterion: object
The object containing all of the fields for a particular workflow criterion.
- id:
-
The numerical ID of the criterion.
- skuPriceId:
-
The ID of the price rule.
- labelId:
-
The ID of the label to match against.
- matchCriteria:
-
The criteria for matching the provided labels to the criteria labels.
Example
{
"id": "number",
"skuPriceId": "number",
"labelId": "number",
"matchCriteria": "string"
}
PriceRuleCriterionPayload: object
The return type for price rule criteria queries and mutations.
- priceRuleCriterion:
-
The Price Rule Criterion object.
Example
{
"priceRuleCriterion": {
"id": "number",
"skuPriceId": "number",
"labelId": "number",
"matchCriteria": "string"
}
}
PriceRuleMatchCriteria: string
The options for price rule criteria matching.
-
objectCONTAINS
-
Matches if the criteria contains the provided label.
-
objectNOT_CONTAINS
-
Matches if the criteria does not contain the provided label.
-
objectONLY_CONTAINS
-
Matches if the criteria only contains the provided label.
PriceRulePayload: object
The return type for price rule queries and mutations.
- priceRule:
-
The Price Rule object.
Example
{
"priceRule": {
"id": "number",
"accountId": "number",
"skuId": "number",
"skuName": "string",
"skuCode": "string",
"quantity": "number",
"price": "number",
"unit": "string",
"criteria": [
{
"id": "number",
"skuPriceId": "number",
"labelId": "number",
"matchCriteria": "string"
}
],
"createdAt": "string"
}
}
Product: object
The object containing all of the fields for a particular product.
- id:
-
The numerical ID of the product.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this product.
- labels:
-
The array of Labels associated with this product.
- skus:
-
The array of SKUs associated with this product.
- customFields:
-
The array of Custom Fields associated with this product.
- displayId:
-
The alphanumeric ID that is displayed for this product.
- name:
-
The name of the product.
- description:
-
The description of the product.
- templateId:
-
The ID of the product template associated with this product.
- storeUrl:
-
The URL of the product on the storefront based on the template ID.
- createdAt:
-
The DateTime when the product was created.
- updatedAt:
-
The DateTime when the product was updated.
Example
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"skus": [
{
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number",
"accountId": "number"
}
]
}
]
}
ProductCategory: object
The object containing all of the fields for a particular product category.
- id:
-
The numerical ID of the category.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this category.
- labels:
-
The array of Labels associated with this category.
- nodes:
-
The object containing parent and child categories for this category.
- templateId:
-
The alphanumeric ID of the template for this category page.
- name:
-
The name of the category.
- description:
-
The description of the category.
- storeUrl:
-
The URL of the category on the storefront based on the template ID and associated labels.
- createdAt:
-
The DateTime when the category was created.
- updatedAt:
-
The DateTime when the category was updated.
Example
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
]
}
]
}
]
}
}
]
}
}
]
}
}
ProductCategoryNodes: object
The object containing parent and child categories for a particular product category.
- subCategories:
-
The array of subcategories associated with this product category.
- parentCategories:
-
The array of parent categories associated with this product category. The parent hierarchy will be listed in order.
Example
{
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string"
}
]
}
]
}
}
]
}
}
]
}
}
]
}
ProductCategoryPayload: object
The return type for product category queries and mutations.
- productCategory:
-
The Product Category object.
Example
{
"productCategory": {
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"nodes": {
"subCategories": [
{
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
null
]
}
]
}
]
}
}
]
}
}
]
}
}
}
ProductPayload: object
The return type for product queries and mutations.
- product:
-
The Product object.
Example
{
"product": {
"id": "number",
"accountId": "number",
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"skus": [
{
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number"
}
]
}
]
}
}
Project: object
The object containing all of the fields for a particular project.
- id:
-
The numerical ID of the project.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this project.
- name:
-
The project name.
- url:
-
The url of the project.
- isActive:
-
The active state of the project.
- createdAt:
-
The DateTime when the template was created.
- updatedAt:
-
The DateTime when the template was updated.
Example
{
"id": "number",
"accountId": "number",
"name": "string",
"url": "string",
"isActive": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
ProjectPayload: object
The return type for project queries and mutations.
- project:
-
The Project object.
Example
{
"project": {
"id": "number",
"accountId": "number",
"name": "string",
"url": "string",
"isActive": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
}
PullSalesOrdersInput: object
The variables for pulling orders from ShipStation.
- shipStationOrderIds:
-
The ShipStation Order IDs to pull. If none are specified, all orders created since the last import will be pulled. If specified, the statusFilters variable will be ignored.
- statusFilters:
-
The ShipStation order statuses to filter pulled orders by.
- isTrialRun:
-
The boolean indicating if this is a trial run. If so, nothing will be created in the database.
- isLastImportIgnored:
-
The boolean indicating if the last import times should be ignored. If so, it will pull all orders with the specified status filters, regardless of when they were created. If pulling specific Order IDs, the last import times will automatically be ignored.
Example
{
"shipStationOrderIds": [
"string"
],
"statusFilters": [
"string"
],
"isTrialRun": "boolean",
"isLastImportIgnored": "boolean"
}
PullSalesOrdersPayload: object
- pulledOrders:
Example
{
"pulledOrders": [
{
"shipStationOrderId": "string",
"errors": [
"string"
],
"invalidSkus": [
"string"
],
"newSalesOrderIds": [
"number"
],
"newCustomerIds": [
"number"
],
"newAddressIds": [
"number"
],
"newPriceRuleIds": [
"number"
],
"newLineItemIds": [
"number"
]
}
]
}
PullShipmentsInput: object
The variables for pulling data from ShipStation.
- salesOrderIds:
-
The IDs of Sales Orders to update with data from ShipStation.
Example
{
"salesOrderIds": [
"number"
]
}
PullShipmentsPlayload: object
- updatedPackages:
Example
{
"updatedPackages": [
{
"packageId": "number",
"trackingNumber": "string",
"error": "string"
}
]
}
PulledOrder: object
- shipStationOrderId:
- errors:
- invalidSkus:
- newSalesOrderIds:
- newCustomerIds:
- newAddressIds:
- newPriceRuleIds:
- newLineItemIds:
Example
{
"shipStationOrderId": "string",
"errors": [
"string"
],
"invalidSkus": [
"string"
],
"newSalesOrderIds": [
"number"
],
"newCustomerIds": [
"number"
],
"newAddressIds": [
"number"
],
"newPriceRuleIds": [
"number"
],
"newLineItemIds": [
"number"
]
}
PurchaseLineItem: object
The object containing all of the fields for a particular line item on purchase processes.
- id:
-
The numerical ID of the Line Item.
- skuId:
-
The numerical ID of the SKU associated with this line item.
- cost:
-
The cost of the line item.
- quantity:
-
The quantity ordered.
- total:
-
The total cost of the line item.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
Example
{
"id": "number",
"skuId": "number",
"cost": "number",
"quantity": "number",
"total": "number",
"name": "string",
"description": "string"
}
PurchaseLineItemInput: object
The input variables for creating line items on purchase processes.
- id:
-
The numerical ID of the Line Item.
- cost:
-
The cost of the line item. Will default to the cost on the Cost Rule associated with this line item.
- quantity:
-
The quantity ordered.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- remove:
-
If this is set to true, it will remove the line item from the assigned object.
Example
{
"id": "number",
"cost": "number",
"quantity": "number",
"name": "string",
"description": "string",
"remove": "boolean"
}
PurchaseOrder: object
The object containing all of the fields for a particular purchase order.
- id:
-
The numerical ID of the purchase order.
- displayId:
-
The display ID of the purchase order.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this purchase order.
- altId:
-
The alternative ID of the purchase order.
- warehouseId:
-
The numerical ID of the Warehouse associated with this purchase order.
- warehouse:
-
The Warehouse associated with this purchase order.
- vendorId:
-
The numerical ID of the Vendor associated with this purchase order.
- vendor:
-
The Vendor associated with this purchase order.
- statusId:
-
The numerical ID of the Status associated with this purchase order.
- statusName:
-
The name of the Status associated with this purchase order.
- notes:
-
The internal notes associated with this purchase order.
- externalNotes:
-
The notes intended for the vendor.
- issuedDate:
-
The date this purchase order was placed.
- dueDate:
-
The date that this purchase order is due.
- labels:
-
The Labels associated with this purchase order.
- customFields:
-
The array of Custom Fields associated with this purchase order.
- lineItems:
-
The Line Items associated with this purchase order.
- receivements:
-
The Receivements associated with this purchase order.
- receipts:
-
The Receipts associated with this purchase order.
- quickBooksId:
-
The QuickBooks ID associated with this purchase order.
- quickBooksSyncToken:
-
The QuickBooks sync token associated with this purchase order.
- total:
-
The total cost of the purchase order.
- createdAt:
-
The DateTime when the purchase order was created.
- updatedAt:
-
The DateTime when the purchase order was updated.
Example
{
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"warehouseId": "number",
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string",
"updatedAt": "string"
}
}
PurchaseOrderPayload: object
The return type for purchase order queries and mutations.
- purchaseOrder:
-
The PurchaseOrder object.
Example
{
"purchaseOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"warehouseId": "number",
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string"
}
}
}
PushSalesOrdersInput: object
The variables for pushing data to ShipStation.
- salesOrderId:
-
The ID of the Sales Order to push to ShipStation. If this is the only defined parameter, all packages within all shipments associated with this Sales Order will be pushed.
- shipmentId:
-
The ID of the Shipment to push to ShipStation. If no packageId is defined, all packages within this shipment will be pushed.
- packageId:
-
The ID of the Package to push to ShipStation.
Example
{
"salesOrderId": "number",
"shipmentId": "number",
"packageId": "number"
}
PushSalesOrdersPayload: object
- orders:
Example
{
"orders": [
{
"salesOrderId": "number",
"shipmentId": "number",
"packageId": "number",
"shipStationOrderId": "string",
"shipStationOrderKey": "string",
"shipStationOrderNumber": "string",
"error": "string"
}
]
}
QuickBooksAccountResponse: object
- Id:
-
The QuickBooks ID for the account.
- SyncToken:
-
The QuickBooks sync token for the account.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
- Name:
-
The name of the QuickBooks account
- SubAccount:
-
Whether or not the account is a subaccount
- FullyQualifiedName:
-
The fully qualified name of the account
- Active:
-
Whether or not the account is active
- Classification:
-
The classification of the account
- AccountType:
-
The type of the account
- AccountSubType:
-
The subtype of the account
- CurrentBalance:
-
The outstanding balance on the account
- CurrentBalanceWithSubAccounts:
-
The outstanding balance on the account including subaccounts
- CurrencyRef:
-
The currency reference on the account
Example
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"Name": "string",
"SubAccount": "boolean",
"FullyQualifiedName": "string",
"Active": "boolean",
"Classification": "string",
"AccountType": "string",
"AccountSubType": "string",
"CurrentBalance": "number",
"CurrentBalanceWithSubAccounts": "number",
"CurrencyRef": {
"name": "string",
"value": "string"
}
}
QuickBooksAccountsPayload: object
The return type for the QuickBooks Accounts query.
- accounts:
-
The QuickBooks accounts
Example
{
"accounts": [
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"Name": "string",
"SubAccount": "boolean",
"FullyQualifiedName": "string",
"Active": "boolean",
"Classification": "string",
"AccountType": "string",
"AccountSubType": "string",
"CurrentBalance": "number",
"CurrentBalanceWithSubAccounts": "number",
"CurrencyRef": {
"name": "string",
"value": "string"
}
}
]
}
QuickBooksAddress: object
The return type for the QuickBooks Company Info query Company Address.
- Id:
-
The QuickBooks ID for the Company Address.
- Line1:
-
The first line of the QuickBooks Company Address.
- City:
-
The city of the QuickBooks Company Address.
- CountrySubDivisionCode:
-
The country subdivision code of the QuickBooks Company Address.
- PostalCode:
-
The postal code of the QuickBooks Company Address.
Example
{
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
}
QuickBooksAuthUriPayload: object
The return type for the QuickBooks Auth URI query
- uri:
-
The URI for starting a QuickBooks OAuth 2.0 authentication.
Example
{
"uri": "string"
}
QuickBooksBillResponse: object
- Id:
-
The QuickBooks ID for the bill.
- SyncToken:
-
The QuickBooks sync token for the bill.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
- SalesTermRef:
-
The sales term reference for the bill
- DueDate:
-
The due date on the bill
- Balance:
-
The outstanding balance on the bill
- TxnDate:
-
The transaction date of the bill
- CurrencyRef:
-
A reference to the currency associated with this bill
- Line:
-
The purchase order lines associated with this bill
- VendorRef:
-
A reference to the vendor associated with this bill
- APAccountRef:
-
A reference to the accounts payable account associated with this bill
- TotalAmt:
-
The total amount of the bill
Example
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"SalesTermRef": {
"name": "string",
"value": "string"
},
"DueDate": "string",
"Balance": "number",
"TxnDate": "string",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"Line": [
{
"Id": "string"
}
],
"VendorRef": {
"name": "string",
"value": "string"
},
"APAccountRef": {
"name": "string",
"value": "string"
},
"TotalAmt": "number"
}
QuickBooksBillsPayload: object
The return type for the QuickBooks Bills query.
- bills:
-
The QuickBooks bills
Example
{
"bills": [
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"SalesTermRef": {
"name": "string",
"value": "string"
},
"DueDate": "string",
"Balance": "number",
"TxnDate": "string",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"Line": [
{
"Id": "string"
}
],
"VendorRef": {
"name": "string",
"value": "string"
},
"APAccountRef": {
"name": "string",
"value": "string"
},
"TotalAmt": "number"
}
]
}
QuickBooksCompanyInfoPayload: object
The return type for the QuickBooks Company Info query.
- Id:
-
The QuickBooks ID for the Company Info.
- SyncToken:
-
The QuickBooks sync token for the Company Info.
- CompanyName:
-
The QuickBooks company name associated with this account.
- LegalName:
-
The QuickBooks legal name associated with this account.
- CompanyAddr:
-
The QuickBooks company address associated with this account.
- Country:
-
The QuickBooks country associated with this account.
- Email:
-
The QuickBooks email associated with this account.
Example
{
"Id": "string",
"SyncToken": "string",
"CompanyName": "string",
"LegalName": "string",
"CompanyAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"Country": "string",
"Email": {
"Address": "string"
}
}
QuickBooksCustomerResponse: object
- Id:
-
The QuickBooks ID for the customer.
- SyncToken:
-
The QuickBooks sync token for the customer.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
- Taxable:
-
Whether or not this customer is taxable
- BillAddr:
-
The billing address of the customer
- Job:
-
Whether or not the job of this customer is known
- BillWithParent:
-
Whether or not to bill the customer with a parent company
- Balance:
-
The outstanding balance associated with the customer
- BalanceWithJobs:
-
The outstanding balance associated with the customer including jobs
- CurrencyRef:
-
The reference to the currency used with the customer
- PreferredDeliveryMethod:
-
The preferred delivery method of the customer
- FullyQualifiedName:
-
The fully qualified name of the customer
- DisplayName:
-
The display name of the customer
- PrintOnCheckName:
-
The name to print on checks for the customer
- Active:
-
Whether or not the customer is active
- PrimaryPhone:
-
The primary phone number associated with the customer
- PrimaryEmailAddr:
-
The primary email address associated with the customer
Example
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"Taxable": "boolean",
"BillAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"Job": "boolean",
"BillWithParent": "boolean",
"Balance": "number",
"BalanceWithJobs": "number",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"PreferredDeliveryMethod": "string",
"FullyQualifiedName": "string",
"DisplayName": "string",
"PrintOnCheckName": "string",
"Active": "boolean",
"PrimaryPhone": {
"FreeFormNumber": "string"
},
"PrimaryEmailAddr": {
"Address": "string"
}
}
QuickBooksCustomersPayload: object
The return type for the QuickBooks Customers query.
- customers:
-
The QuickBooks customers
Example
{
"customers": [
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"Taxable": "boolean",
"BillAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"Job": "boolean",
"BillWithParent": "boolean",
"Balance": "number",
"BalanceWithJobs": "number",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"PreferredDeliveryMethod": "string",
"FullyQualifiedName": "string",
"DisplayName": "string",
"PrintOnCheckName": "string",
"Active": "boolean",
"PrimaryPhone": {
"FreeFormNumber": "string"
},
"PrimaryEmailAddr": {
"Address": "string"
}
}
]
}
QuickBooksEmail: object
The QuickBooks Email object.
- Address:
-
The email address of the QuickBooks Company.
Example
{
"Address": "string"
}
QuickBooksInvoiceResponse: object
The QuickBooks invoice response.
- Id:
-
The QuickBooks ID for the invoice.
- SyncToken:
-
The QuickBooks sync token for the invoice.
- BillAddr:
-
The billing address for the invoice.
- ShipAddr:
-
The shipping address for the invoice.
- DocNumber:
-
The QuickBooks document number for the invoice.
- TxnDate:
-
The transaction date for the invoice.
- DueDate:
-
The due date for the invoice.
- TotalAmt:
-
The total amount of the invoice.
- ApplyTaxAfterDiscount:
-
Whether or not to apply tax after discount for the invoice.
- Balance:
-
The outstanding balance on the invoice.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- AllowOnlinePayment:
-
Whether or not this invoice allows online payments
- AllowOnlineCreditCardPayment:
-
Whether or not this invoice allows online credit card payments
- AllowOnlineACHPayment:
-
Whether or not this invoice allows online ACH payments
- SalesTermRef:
-
The sales term reference
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
Example
{
"Id": "string",
"SyncToken": "string",
"BillAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"ShipAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"DocNumber": "string",
"TxnDate": "string",
"DueDate": "string",
"TotalAmt": "number",
"ApplyTaxAfterDiscount": "boolean",
"Balance": "number",
"sparse": "boolean",
"domain": "string",
"AllowOnlinePayment": "boolean",
"AllowOnlineCreditCardPayment": "boolean",
"AllowOnlineACHPayment": "boolean",
"SalesTermRef": {
"name": "string",
"value": "string"
},
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
}
}
QuickBooksInvoicesPayload: object
The return type for the QuickBooks Invoices query.
- invoices:
-
The QuickBooks invoices
Example
{
"invoices": [
{
"Id": "string",
"SyncToken": "string",
"BillAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"ShipAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"DocNumber": "string",
"TxnDate": "string",
"DueDate": "string",
"TotalAmt": "number",
"ApplyTaxAfterDiscount": "boolean",
"Balance": "number",
"sparse": "boolean",
"domain": "string",
"AllowOnlinePayment": "boolean",
"AllowOnlineCreditCardPayment": "boolean",
"AllowOnlineACHPayment": "boolean",
"SalesTermRef": {
"name": "string",
"value": "string"
},
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
}
}
]
}
QuickBooksItemResponse: object
The QuickBooks item response.
- Id:
-
The QuickBooks ID for the item.
- SyncToken:
-
The QuickBooks sync token for the item.
- Name:
-
The name of the item.
- Description:
-
The description of the item.
- Active:
-
Whether or not the item is active.
- FullyQualifiedName:
-
The fully qualified name of the item.
- Taxable:
-
Whether or not the item is taxable.
- UnitPrice:
-
The unit price of the item.
- Type:
-
The type of the item.
- PurchaseDesc:
-
The description of the item purchase.
- PurchaseCost:
-
The cost to purchase the item.
- TrackQtyOnHand:
-
Whether QuickBooks is tracking the quantity on hand of the item.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
- IncomeAccountRef:
-
The QuickBooks income account reference
- ExpenseAccountRef:
-
The QuickBooks expense account reference
Example
{
"Id": "string",
"SyncToken": "string",
"Name": "string",
"Description": "string",
"Active": "boolean",
"FullyQualifiedName": "string",
"Taxable": "boolean",
"UnitPrice": "number",
"Type": "string",
"PurchaseDesc": "string",
"PurchaseCost": "number",
"TrackQtyOnHand": "boolean",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"IncomeAccountRef": {
"name": "string",
"value": "string"
},
"ExpenseAccountRef": {
"name": "string",
"value": "string"
}
}
QuickBooksItemsPayload: object
The return type for the QuickBooks Items query.
- items:
-
The QuickBooks items
Example
{
"items": [
{
"Id": "string",
"SyncToken": "string",
"Name": "string",
"Description": "string",
"Active": "boolean",
"FullyQualifiedName": "string",
"Taxable": "boolean",
"UnitPrice": "number",
"Type": "string",
"PurchaseDesc": "string",
"PurchaseCost": "number",
"TrackQtyOnHand": "boolean",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"IncomeAccountRef": {
"name": "string",
"value": "string"
},
"ExpenseAccountRef": {
"name": "string",
"value": "string"
}
}
]
}
QuickBooksPayload: object
The return type for quickbooks queries and mutations.
- isActive:
-
If this is set to true, it means the account is connected to QuickBooks and ready to make API calls.
Example
{
"isActive": "boolean"
}
QuickBooksPhone: object
The QuickBooks Phone object.
- FreeFormNumber:
-
The free form phone number.
Example
{
"FreeFormNumber": "string"
}
QuickBooksPurchaseOrderLine: object
The QuickBooks purchase order line item
- Id:
-
The QuickBooks ID for the purchase order line item.
Example
{
"Id": "string"
}
QuickBooksPurchaseOrderResponse: object
The QuickBooks purchase order response.
- Id:
-
The QuickBooks ID for the purchase order.
- SyncToken:
-
The QuickBooks sync token for the purchase order.
- VendorAddr:
-
The vendor address.
- ShipAddr:
-
The shipping address.
- POStatus:
-
The status of the purchase order.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
- DocNumber:
-
The QuickBooks document number for the purchase order.
- TxnDate:
-
The date of the transaction.
- CurrencyRef:
-
The currency reference.
- LinkedTxn:
-
The date of the transaction.
- Line:
-
The lines in the purchase order.
- VendorRef:
-
The vendor reference.
- APAccountRef:
-
The accounts payable account reference.
- TotalAmt:
-
The total amount of the vendor.
Example
{
"Id": "string",
"SyncToken": "string",
"VendorAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"ShipAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"POStatus": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"DocNumber": "number",
"TxnDate": "string",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"LinkedTxn": "string",
"Line": [
{
"Id": "string"
}
],
"VendorRef": {
"name": "string",
"value": "string"
},
"APAccountRef": {
"name": "string",
"value": "string"
},
"TotalAmt": "number"
}
QuickBooksPurchaseOrdersPayload: object
The return type for the QuickBooks Purchase Orders query.
- purchaseOrders:
-
The QuickBooks purchase orders
Example
{
"purchaseOrders": [
{
"Id": "string",
"SyncToken": "string",
"VendorAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"ShipAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"POStatus": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"DocNumber": "number",
"TxnDate": "string",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"LinkedTxn": "string",
"Line": [
{
"Id": "string"
}
],
"VendorRef": {
"name": "string",
"value": "string"
},
"APAccountRef": {
"name": "string",
"value": "string"
},
"TotalAmt": "number"
}
]
}
QuickBooksSyncType: string
The options for QuickBooks syncs.
-
objectINVOICES
-
The sync type for pushing invoices.
-
objectSALES_ORDERS
-
The sync type for pushing sales order line items as invoices.
-
objectPURCHASE_ORDERS
-
The sync type for pushing purchase orders.
-
objectBILLS
-
The sync type for pushing purchase order receipts as bills.
QuickBooksVendorResponse: object
- Id:
-
The QuickBooks ID for the vendor.
- SyncToken:
-
The QuickBooks sync token for the vendor.
- sparse:
-
Whether the response received from QuickBooks was sparse or complete.
- domain:
-
The domain of this QuickBooks account (e.g. QBO = QuickBooks Online).
- MetaData:
-
The metadata from QuickBooks (created and last updated timestamps)
- BillAddr:
-
The billing address.
- Balance:
-
The outstanding balance owed to the vendor.
- Vendor1099:
-
Whether or not the vendor is on a 1099.
- CurrencyRef:
-
The reference to the currency used with this vendor.
- GivenName:
-
The given name of the vendor.
- CompanyName:
-
The company name of the vendor.
- DisplayName:
-
The display name of the vendor.
- PrintOnCheckName:
-
The name to print on checks for the vendor.
- Active:
-
Whether or not the vendor is active.
- PrimaryPhone:
-
The primary phone number of the vendor
- PrimaryEmailAddr:
-
The primary email address of the vendor
Example
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"BillAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"Balance": "number",
"Vendor1099": "boolean",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"GivenName": "string",
"CompanyName": "string",
"DisplayName": "string",
"PrintOnCheckName": "string",
"Active": "boolean",
"PrimaryPhone": {
"FreeFormNumber": "string"
},
"PrimaryEmailAddr": {
"Address": "string"
}
}
QuickBooksVendorsPayload: object
The return type for the QuickBooks Vendors query.
- vendors:
-
The QuickBooks vendors
Example
{
"vendors": [
{
"Id": "string",
"SyncToken": "string",
"sparse": "boolean",
"domain": "string",
"MetaData": {
"CreateTime": "string",
"LastUpdatedTime": "string"
},
"BillAddr": {
"Id": "string",
"Line1": "string",
"City": "string",
"CountrySubDivisionCode": "string",
"PostalCode": "string"
},
"Balance": "number",
"Vendor1099": "boolean",
"CurrencyRef": {
"name": "string",
"value": "string"
},
"GivenName": "string",
"CompanyName": "string",
"DisplayName": "string",
"PrintOnCheckName": "string",
"Active": "boolean",
"PrimaryPhone": {
"FreeFormNumber": "string"
},
"PrimaryEmailAddr": {
"Address": "string"
}
}
]
}
Receipt: object
The object containing all of the fields for a particular purchase order receipt.
- id:
-
The numerical ID of the receipt.
- purchaseOrderId:
-
The numerical ID of the purchase order corresponding to this receipt.
- purchaseOrder:
-
The purchase order for this receipt.
- lineItems:
-
The line items and quantities being accounted for in this receipt.
- altId:
-
The alternative display id for this receipt.
- notes:
-
The notes on this receipt.
- statusId:
-
The numerical ID of the Status associated with this receipt.
- statusName:
-
The name of the Status associated with this purchase order.
- dueDate:
-
The due date
- total:
-
The total cost of the receipt.
- createdAt:
-
The DateTime when the purchase order was created.
Example
{
"id": "number",
"purchaseOrderId": "number",
"purchaseOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"warehouseId": "number",
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
]
}
}
}
ReceiptInput: object
The input variables for creating purchase order receipts.
- id:
-
The numerical ID of the receipt if it already exists. Required for updating.
- lineItems:
-
The line items and quantities being accounted for in this receipt.
- altId:
-
The alternative display id for this receipt.
- notes:
-
The notes on this receipt.
- statusId:
-
The numerical ID of the Status associated with this receipt.
- dueDate:
-
The due date.
- remove:
-
If this is set to true, it will remove the receipt from the assigned object.
Example
{
"id": "number",
"lineItems": [
{
"lineItemId": "number",
"quantity": "number",
"cost": "number",
"remove": "boolean"
}
],
"altId": "string",
"notes": "string",
"statusId": "number",
"dueDate": "object",
"remove": "boolean"
}
ReceiptLineItem: object
The object containing all of the fields for a receipt line item.
- lineItemId:
-
The numerical ID of the line item being accounted for.
- name:
-
The name of the line item.
- description:
-
The description of the line item.
- quantity:
-
The quantity accounted for.
- cost:
-
The unit cost of the items being accounted for.
- total:
-
The total cost of the line item.
Example
{
"lineItemId": "number",
"name": "string",
"description": "string",
"quantity": "number",
"cost": "number",
"total": "number"
}
ReceiptLineItemInput: object
The input variables for adding line items to receipts.
- lineItemId:
-
The numerical ID of the line item being accounted for.
- quantity:
-
The quantity accounted for. Cannot exceed quantity received.
- cost:
-
The unit cost of the items being accounted for.
- remove:
-
If this is set to true, it will remove the line item from the receipt.
Example
{
"lineItemId": "number",
"quantity": "number",
"cost": "number",
"remove": "boolean"
}
Receivement: object
The object containing all of the fields for a particular receivement.
- id:
-
The numerical ID of the receivement.
- purchaseOrderId:
-
The numerical ID of the purchase order associated with this receivement.
- purchaseOrder:
-
The purchase order associated with this receivement.
- purchaseOrderDisplayId:
-
The display ID of the purchase order.
- lineItemId:
-
The numerical ID of the Line Item being received.
- skuId:
-
The numerical ID of the SKU being received.
- name:
-
The name of the LineItem being received.
- description:
-
The description of the LineItem being received.
- binId:
-
The numerical ID of the receivement's Bin Location.
- binName:
-
The name of the Bin Location bin location received to.
- quantity:
-
The quantity received.
- lot:
-
The Lot created by this receivement.
- lots:
-
The Lots created by this receivement. Only applicable on consolidated receivement queries.
- originLot:
-
The original Lot consumed by this receivement on certain processes (e.g., Transfers, Sales Orders, Work Orders).
- altLotNumber:
-
The alternative identifier of the lot, for custom metadata.
- serialNumber:
-
The serial number of the received inventory. Only applicable to single items being received.
- expirationDate:
-
The date this piece of inventory expires.
- manufactureDate:
-
The date this piece of inventory was manufactured.
- lotNumber:
-
The lot number of the received inventory.
- createdAt:
-
The DateTime when the purchase order was created.
Example
{
"id": "number",
"purchaseOrderId": "number",
"purchaseOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"warehouseId": "number",
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
]
}
}
}
ReceivementInput: object
The input variables for creating receivements.
- id:
-
The numerical ID of the receivement if it already exists. Required for updating.
- originLotId:
-
The numerical ID of the Lot you wish to receive from if you are using lot mapping.
- lineItemId:
-
The numerical ID of the Line Item being received.
- binId:
-
The numerical ID of the receivement's Bin Location.
- quantity:
-
The quantity received. Cannot exceed quantity ordered.
- lotNumber:
-
The lot number of the received inventory.
- altLotNumber:
-
The alternative identifier of the lot, for custom metadata.
- serialNumber:
-
The serial number of the received inventory. Only applicable to single items being received.
- manufactureDate:
-
The date this piece of inventory was manufactured.
- expirationDate:
-
The date this piece of inventory expires.
- remove:
-
If this is set to true, it will remove the receivement from the assigned object.
Example
{
"id": "number",
"originLotId": "number",
"lineItemId": "number",
"binId": "number",
"quantity": "number",
"lotNumber": "string",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object",
"remove": "boolean"
}
ResetType: string
The options available for data resets.
-
objectSKUS
-
This will delete your SKUs and everything associated with them.
-
objectCUSTOMERS
-
This will delete your Customers, and everything associated with them.
-
objectINVENTORY
-
This will reset all of your inventory levels without deleting your SKUs.
-
objectVENDORS
-
This will reset your vendors and purchase orders.
-
objectWAREHOUSES
-
This will reset your warehouses.
SKU: object
The object containing all of the fields for a particular sku.
- id:
-
The numerical ID of the sku.
- isKit:
-
The flag for determining if the SKU is a kit or not.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this sku.
- productId:
-
The numerical ID of the Product associated with this sku.
- code:
-
The identifier of the sku (UPC, GTIN, etc).
- name:
-
The display name of the sku.
- stockLevels:
-
The stock levels of the sku.
- binStockLevels:
-
The stock levels in the bins for this sku, regardless of the filter used.
- vendors:
-
The Vendors associated with this sku.
- labels:
-
The Labels associated with this sku.
- files:
-
The File Mappings associated with this sku.
- billOfMaterials:
-
The Bill of Materials consumed by assembly of this sku.
- customFields:
-
The array of Custom Fields associated with this sku.
- lots:
-
The array of Lots associated with this sku.
- defaultBins:
-
The array of Bin Locations most recently used for this sku, grouped by warehouse.
- minStockLevel:
-
The minimum stock level for this sku.
- maxStockLevel:
-
The maximum stock level for this sku.
- priceRules:
-
The Price Rules associated with this sku.
- createdAt:
-
The DateTime when the sku was created.
- updatedAt:
-
The DateTime when the sku was updated.
- quickBooksId:
-
The QuickBooks Item ID associated with this sku.
- quickBooksSyncToken:
-
The QuickBooks Item sync token associated with this sku.
Example
{
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string"
}
]
}
]
}
SKUCore: object
The object containing all of the core fields for a particular sku.
Example
{
"id": "number",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string"
}
SKUPayload: object
The return type for sku queries and mutations.
- sku:
-
The SKU object.
Example
{
"sku": {
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string"
}
]
}
]
}
}
SKUVelocity: object
The object containing all of the fields for a SKU Velocity Report.
- skuId:
-
The ID of the SKU.
- sku:
-
The SKU belonging to this record.
- averageUnitsSold:
-
The average units sold per week in the given time period.
- unitsSold:
-
The units sold within the given time period.
- revenue:
-
The total revenue of units sold within the given time period.
- unitsAdded:
-
The units purchased or added within the given time period.
- cost:
-
The total cost of units purchased within the given time period.
- daysLeft:
-
The approximate days left until zero available stock for this inventory item, based on the current available quantity and average units sold per day.
- inStock:
-
The current in stock value for the selected SKU.
- available:
-
The current available stock value for the selected SKU.
- backordered:
-
The current backordered stock value for the selected SKU.
Example
{
"skuId": "number",
"sku": {
"id": "number",
"isKit": "boolean",
"accountId": "number",
"productId": "number",
"code": "string",
"name": "string",
"stockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"binStockLevels": [
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
],
"vendors": [
{
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number",
"accountId": "number"
}
]
}
]
}
}
SalesLineItem: object
The object containing all of the fields for a particular line item on sales processes.
- id:
-
The numerical ID of the Line Item.
- salesOrderId:
-
The numerical ID of the Sales Order this line item belongs to.
- salesOrderDisplayId:
-
The display ID of the Sales Order this line item belongs to.
- salesOrderLineItemId:
-
The numerical ID of the Line Item on this specific sales order.
- warehouseId:
-
The numerical ID of the Warehouse you wish to ship from. Defaults to the warehouse on the Sales Order.
- skuId:
-
The numerical ID of the SKU associated with this line item.
- total:
-
The total price of the line item.
- price:
-
The price of the line item.
- priceRuleId:
-
The id of the price rule belonging to this sales order line item.
- tax:
-
The tax on the line item.
- quantity:
-
The quantity ordered.
- type:
-
The type of line item.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- lots:
-
The array of Lots consumed by this line item.
- costOfGoodsSold:
-
The total cost of lots used on this line item.
- lotMappings:
-
The array of Lots explicitly assigned to this line item.
- bomParentId:
-
The id of the sales line item acting as the parent of this line item.
- bomQuantityMultiplier:
-
The quantity multiplier for the bill of material if the bill of material is set to use a dynamic quantity.
- bomIsFixed:
-
The value determining whether or not the bill of material uses a fixed or dynamic quantity.
- isBomParent:
-
The flag determining whether or not a line item is a bill of material parent (used for kits).
Example
{
"id": "number",
"salesOrderId": "number",
"salesOrderDisplayId": "number",
"salesOrderLineItemId": "number",
"warehouseId": "number",
"skuId": "number",
"total": "number",
"price": "number",
"priceRuleId": "number",
"tax": "number",
"quantity": "number",
"type": "string",
"name": "string",
"description": "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": [
{
"id": "number",
"accountId": "number",
"skuId": "number",
"skuCode": "string",
"skuName": "string",
"binId": "number",
"binName": "string",
"name": "string"
}
]
}
]
}
SalesLineItemInput: object
The input variables for creating line items on sales processes.
- id:
-
The numerical ID of the Line Item.
- warehouseId:
-
The numerical ID of the Warehouse you wish to ship from. If not passed in, the warehouse on the Sales Order will be used.
- price:
-
The price of the line item. Will default to the cost on the Price Rule associated with this line item.
- tax:
-
The tax on the line item.
- quantity:
-
The quantity ordered.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- bomParentId:
-
The id of the sales line item acting as the parent of this line item. Assigning this or unassigning it will add or remove this line item from the given parent item.
- bomQuantityMultiplier:
-
The quantity multiplier if the bill of material is dynamic. Defaults to 1.
- bomIsFixed:
-
The value determining whether or not the bill of material uses a fixed or dynamic quantity.
- isBomParent:
-
The flag determining whether or not a line item is a bill of material parent (used for kits).
- lotIds:
-
The optional array of Lot IDs to pull inventory from. If this is not specified, then lots will be chosen automatically.
- remove:
-
If this is set to true, it will remove the line item from the assigned object.
Example
{
"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"
}
SalesOrder: object
The object containing all of the fields for a particular sales order.
- id:
-
The numerical ID of the sales order.
- displayId:
-
The display ID of the sales order.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this sales order.
- statusId:
-
The numerical ID of the Status associated with this sales order.
- statusName:
-
The name of the Status associated with this sales order.
- originWarehouseId:
-
The numerical ID of the origin Warehouse associated with this sales order.
- originWarehouse:
-
The origin Warehouse associated with this sales order.
- altId:
-
The alternative ID of the sales order.
- customerId:
-
The numerical ID of the Customer associated with this sales order.
- customer:
-
The Customer associated with this sales order.
- users:
-
The users Users associated with this sales order.
- labels:
-
The Labels associated with this sales order.
- customFields:
-
The array of Custom Fields associated with this sales order.
- lineItems:
-
The Line Items associated with this sales order.
- shipments:
-
The Shipments associated with this sales order.
- returns:
-
The Returns associated with this sales order.
- payments:
-
The Payments associated with this sales order.
- invoices:
-
The Invoices associated with this sales order.
- notes:
-
The internal notes on this sales order.
- externalNotes:
-
The external notes on this sales order.
- shipDate:
-
The date this order was shipped.
- cancelByDate:
-
The date that this order should be canceled by.
- customerPo:
-
The Customer PO Number.
- billingAddressId:
-
The numerical ID of the Billing Address.
- billingAddress:
-
The Billing Address.
- shippingAddressId:
-
The numerical ID of the Shipping Address.
- shippingAddress:
-
The Shipping Address.
- subTotal:
-
The total price value of the line items on this sales order.
- discountTotal:
-
The total price value of discount line items on this sales order.
- preDiscountSubTotal:
-
The total price value of line items before applying the discount total on this sales order.
- shippingTotal:
-
The total shipping price of the line items on this sales order.
- taxTotal:
-
The total tax price of the line items on this sales order.
- total:
-
The total price of the sales order.
- costOfGoodsSold:
-
The total cost to purchase the items used in this sales order.
- grossProfit:
-
The total price minus the cost of goods sold.
- openDate:
-
The DateTime when the sales order was marked as placed.
- createdAt:
-
The DateTime when the sales order was created.
- updatedAt:
-
The DateTime when the sales order was updated.
Example
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string"
}
}
SalesOrderPayload: object
The return type for sales order queries and mutations.
- salesOrder:
-
The SalesOrder object.
Example
{
"salesOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
]
}
}
}
ShipStationPayload: object
- shipStation:
Example
{
"shipStation": {
"id": "number",
"accountId": "number",
"apiKey": "string",
"apiSecret": "string",
"isPushActive": "boolean",
"isPullActive": "boolean",
"isActive": "boolean"
}
}
Shipment: object
The object containing all of the fields for a particular shipment.
- id:
-
The numerical ID of the shipment.
- salesOrderId:
-
The the numerical ID of the Sales Order the shipment belongs to.
- salesOrderDisplayId:
-
The the display ID of the Sales Order the shipment belongs to.
- packages:
-
The Packages associated with this shipment.
- salesOrder:
-
The Sales Order associated with the shipment.
- shipDate:
-
The DateTime when the shipment was marked as shipped.
- createdAt:
-
The DateTime when the shipment was created.
- updatedAt:
-
The DateTime when the shipment was updated.
Example
{
"id": "number",
"salesOrderId": "number",
"salesOrderDisplayId": "string",
"packages": [
{
"id": "number",
"trackingNumber": "string",
"items": [
{
"id": "number",
"packageItemId": "number",
"lineItemId": "number",
"name": "string",
"description": "string",
"binId": "number",
"quantity": "number",
"quantityShipped": "number",
"quantityPendingReturn": "number",
"quantityReturned": "number"
}
],
"billingAddressId": "number",
"billingAddress": {
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
},
"shippingAddressId": "number",
"shippingAddress": {
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
},
"shipStationOrderId": "string"
}
],
"salesOrder": {
"id": "number",
"displayId": "number",
"accountId": "number"
}
}
ShipmentInput: object
The input variables for creating a shipment.
Example
{
"id": "number",
"shipDate": "string",
"packages": [
{
"id": "number",
"trackingNumber": "string",
"items": [
{
"id": "number",
"lineItemId": "number",
"lotIds": [
{
"id": "number",
"quantity": "number",
"remove": "boolean"
}
],
"quantity": "number",
"remove": "boolean"
}
],
"billingAddressId": "number",
"shippingAddressId": "number",
"remove": "boolean"
}
],
"remove": "boolean"
}
ShipmentReturn: object
The object containing all of the fields for a particular shipment return.
- id:
-
The numerical ID of the return.
- warehouseId:
-
The numerical ID of the Warehouse the shipment is being returned to. If not specified, this will default to the warehouse on the sales order.
- warehouseName:
-
The name of the warehouse.
- warehouse:
-
The warehouse being returned to.
- salesOrderId:
-
The numerical ID of the Sales Order.
- salesOrder:
-
The Sales Order associated with this shipment return.
- salesOrderDisplayId:
-
The display ID of the sales order.
- customer:
-
The Customer associated with this shipment return.
- returnDate:
-
The return date
- items:
-
The Package Items associated with this return.
- createdAt:
-
The DateTime when the return was created.
- updatedAt:
-
The DateTime when the return was updated.
Example
{
"id": "number",
"warehouseId": "number",
"warehouseName": "string",
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string",
"updatedAt": "string"
},
"salesOrderId": "number",
"salesOrder": {}
}
ShipmentReturnInput: object
The input variables for creating a return.
- id:
-
The numerical ID of the shipment return. Required for updating.
- warehouseId:
-
The numerical ID of the Warehouse you wish to return inventory to.
- packageItems:
-
The array of package items to return.
- returnDate:
-
The date of return.
- remove:
-
If this is set to true, it will remove the return from the sales order.
Example
{
"id": "number",
"warehouseId": "number",
"packageItems": [
{
"id": "number",
"warehouseId": "number",
"binId": "number",
"quantity": "number",
"remove": "boolean"
}
],
"returnDate": "object",
"remove": "boolean"
}
SignedUrl: object
The object containing all of the fields for a particular signed url.
- url:
-
The signed file url.
Example
{
"url": "string"
}
SkuLevelType: string
-
objectIN_STOCK
-
objectZERO_IN_STOCK
-
objectAVAILABLE
-
objectBACKORDERED
-
objectALLOCATED
-
objectCOMMITTED
-
objectTRANSFER_INCOMING
-
objectTRANSFER_OUTGOING
-
objectON_ORDER
-
objectPENDING_RETURN
-
objectIN_PROGRESS
StatusModules: string
The options for filtering statuses by module.
-
objectPURCHASE_ORDERS
-
objectPURCHASE_ORDER_RECEIPTS
-
objectTRANSFERS
-
objectSALES_ORDERS
-
objectSALES_ORDERS_INVOICES
-
objectWORK_ORDERS
-
objectSHIPMENTS
StockHistory: object
The return type for stock history queries.
- id:
-
The numerical ID of the history record.
- skuId:
-
The numerical ID of the SKU.
- skuName:
-
The name of the SKU at the time of stock adjustment.
- skuCode:
-
The code of the SKU.
- warehouseId:
-
The numerical ID of the Warehouse the stock was added to or removed from.
- warehouseName:
-
The name of the Warehouse the stock was added to or removed from.
- lotId:
-
The numerical ID of the Lot the stock was added to or removed from.
- binId:
-
The numerical ID of the Bin Location the stock was added to or removed from.
- binName:
-
The name of the Bin Location the stock was added to or removed from.
- receivementId:
-
The numerical ID of the Purchase Order Receivement the stock was added from (only available if the source of the stock is a Purchase Order).
- purchaseOrderId:
-
The numerical ID of the Purchase Order the stock was added from (only available if the source of the stock is a Purchase Order).
- purchaseOrderDisplayId:
-
The display ID of the purchase order.
- salesOrderId:
-
The numerical ID of the Sales Order the stock was added from (only available if the source of the stock is a Sales Order).
- salesOrderDisplayId:
-
The display ID of the sales order.
- workOrderId:
-
The numerical ID of the Work Order the stock was added from (only available if the source of the stock is a Work Order).
- workOrderDisplayId:
-
The display ID of the work order.
- transferId:
-
The numerical ID of the Transfer the stock was added from (only available if the source of the stock is a Transfer).
- transferDisplayId:
-
The display ID of the transfer.
- quantityAdded:
-
The quantity added or removed from stock.
- type:
-
The type of stock adjustment (e.g., Adjustment, Purchase Order, Sales Order, etc.).
- createdAt:
-
The time that the record was created.
- updatedAt:
-
The last time that the record was updated.
Example
{
"id": "number",
"skuId": "number",
"skuName": "string",
"skuCode": "string",
"warehouseId": "number",
"warehouseName": "string",
"lotId": "number",
"binId": "number",
"binName": "string",
"receivementId": "number",
"purchaseOrderId": "number",
"purchaseOrderDisplayId": "string",
"salesOrderId": "number",
"salesOrderDisplayId": "string",
"workOrderId": "number",
"workOrderDisplayId": "string",
"transferId": "number",
"transferDisplayId": "string",
"quantityAdded": "number",
"type": "string",
"createdAt": "object",
"updatedAt": "object"
}
StockHistoryType: string
The options for stock history type.
-
objectADJUSTMENT
-
objectSALES_ORDER
-
objectPURCHASE_ORDER
-
objectTRANSFER
-
objectWORK_ORDER
StockLevel: object
The return type for stock queries.
- warehouseId:
-
The numerical ID of the Warehouse associated with this stock.
- binId:
-
The numerical ID of the Bin Location associated with this stock.
- inStock:
-
The quantity in stock.
- available:
-
The quantity available for use.
- backordered:
-
The quantity backordered.
- allocated:
-
The quantity that has been allocated to an inventory process (orders, work orders, transfers, etc).
- committed:
-
The quantity committed on orders and work orders.
- onOrder:
-
The quantity currently incoming for this sku.
- transferOutgoing:
-
The quantity actively transferring out for this sku.
- transferIncoming:
-
The quantity actively transferring in for this sku.
- pendingReturn:
-
The quantity that is in the process of being returned.
- inProgress:
-
The quantity that is in the process of being assembled.
Example
{
"warehouseId": "number",
"binId": "number",
"inStock": "number",
"available": "number",
"backordered": "number",
"allocated": "number",
"committed": "number",
"onOrder": "number",
"transferOutgoing": "number",
"transferIncoming": "number",
"pendingReturn": "number",
"inProgress": "number"
}
StoreAddressInput: object
- accountId:
- address:
- storeToken:
Example
{
"accountId": "number",
"address": {
"id": "number",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
},
"storeToken": "string"
}
StoreUser: object
The object containing all of the fields for a store user.
- id:
-
The numerical ID of the user.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this user.
- customer:
-
The Customer associated with this user.
- email:
-
The email address of the user.
- createdAt:
-
The DateTime when the user was created.
- updatedAt:
-
The DateTime when the user was updated.
Example
{
"id": "number",
"accountId": "number",
"customer": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"businessName": "string",
"orders": [
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
{}
]
}
}
]
}
}
StoreUserPayload: object
The return type for store user queries and mutations.
- user:
Example
{
"user": {
"id": "number",
"accountId": "number",
"customer": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"businessName": "string",
"orders": [
{
"id": "number",
"displayId": "number",
"accountId": "number",
"statusId": "number",
"statusName": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"customFields": [
null
]
}
}
]
}
}
}
String: string
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Template: object
The object containing all of the fields for a particular template.
- id:
-
The numerical ID of the template.
- isConsolidated:
-
The flag to determine whether or not this is a consolidated template.
- guestMode:
-
The flag to determine if an e-commerce page is publicly accessible.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this template.
- projectId:
-
The numerical ID of the Project associated with this template.
- fileName:
-
The file name.
- html:
-
The html of the template.
- compiledHTML:
-
The compiled template string.
- previewHTML:
-
The preview template string.
- type:
-
The template type.
- subtype:
-
The template subtype.
- files:
-
The File Mappings associated with this template.
- createdAt:
-
The DateTime when the template was created.
- updatedAt:
-
The DateTime when the template was updated.
Example
{
"id": "number",
"isConsolidated": "boolean",
"guestMode": "boolean",
"accountId": "number",
"projectId": "number",
"fileName": "string",
"html": "string",
"compiledHTML": "string",
"previewHTML": "string",
"type": "string",
"subtype": "string",
"files": [
{
"id": "number",
"uploadId": "number",
"name": "string",
"sortOrder": "number",
"file": {
"id": "number",
"name": "string",
"type": "string",
"size": "number",
"path": "string",
"signedUrl": "string"
}
}
],
"createdAt": "string",
"updatedAt": "string"
}
TemplatePayload: object
The return type for template queries and mutations.
- template:
-
The Template object.
Example
{
"template": {
"id": "number",
"isConsolidated": "boolean",
"guestMode": "boolean",
"accountId": "number",
"projectId": "number",
"fileName": "string",
"html": "string",
"compiledHTML": "string",
"previewHTML": "string",
"type": "string",
"subtype": "string",
"files": [
{
"id": "number",
"uploadId": "number",
"name": "string",
"sortOrder": "number",
"file": {
"id": "number",
"name": "string",
"type": "string",
"size": "number",
"path": "string",
"signedUrl": "string"
}
}
],
"createdAt": "string",
"updatedAt": "string"
}
}
TemplateSubtype: string
The options for template subtypes.
-
objectGENERIC
-
objectINDEX
-
objectLOGIN
-
objectREGISTER
-
objectNOT_FOUND
-
objectCUSTOMERS
-
objectIMAGE
-
objectPURCHASE_ORDERS
-
objectPURCHASE_ORDER_RECEIPTS
-
objectPURCHASE_ORDER_RECEIVEMENTS
-
objectSALES_ORDERS
-
objectSHIPMENTS
-
objectRETURNS
-
objectSALES_ORDER_INVOICES
-
objectTRANSFERS
-
objectWORK_ORDERS
-
objectSKUS
-
objectPRODUCTS
TemplateType: string
The options for template types.
-
objectDOCUMENT
-
objectECOMMERCE
-
objectCUSTOM_APP
Time: object
A time string at UTC, such as 10:15:30Z, compliant with the full-time format outlined in section 5.6 of the RFC 3339profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
object
Transfer: object
The object containing all of the fields for a particular transfer.
- id:
-
The numerical ID of the transfer.
- displayId:
-
The display ID of the transfer.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this transfer.
- altId:
-
The alternative ID of the transfer.
- originWarehouseId:
-
The numerical ID of the origin Warehouse associated with this transfer.
- originWarehouse:
-
The origin Warehouse associated with this transfer.
- destinationWarehouseId:
-
The numerical ID of the destination Warehouse associated with this transfer.
- destinationWarehouse:
-
The destination Warehouse associated with this transfer.
- statusId:
-
The numerical ID of the Status associated with this transfer.
- notes:
-
The internal notes associated with this transfer.
- externalNotes:
-
The notes intended for the vendor.
- issuedDate:
-
The date this transfer was placed.
- dueDate:
-
The date that this transfer is due.
- labels:
-
The Labels associated with this transfer.
- customFields:
-
The array of Custom Fields associated with this transfer.
- lineItems:
-
The Line Items associated with this transfer.
- receivements:
-
The Receivements associated with this transfer.
- createdAt:
-
The DateTime when the transfer was created.
- updatedAt:
-
The DateTime when the transfer was updated.
Example
{
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string",
"updatedAt": "string"
}
}
TransferPayload: object
The return type for transfer queries and mutations.
- transfer:
-
The Transfer object.
Example
{
"transfer": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string"
}
}
}
UpdateAddressInput: object
The input variables for updating addresses.
- id:
-
The numerical ID of the address.
- name:
-
The nickname of the address (e.g., John Smith's House).
- 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/teritory the address resides in.
- country:
-
The code of the country the address resides in.
Example
{
"id": "number",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
UpdateAutomationInput: object
The input variables for updating automations.
- id:
-
The numerical ID of the automation.
- isPaused:
-
The flag that determines whether or not the process will run.
- type:
-
The type of automation action.
- workflowId:
-
The numerical ID of the workflow associated with this automation.
- emailSettings:
-
The configuration for SEND_EMAIL automation actions.
- shipStationStatusFilters:
-
The status filters for ship station actions.
- interval:
-
The interval at which the automation runs if it is set to automatically run.
Example
{
"id": "number",
"isPaused": "boolean",
"type": "string",
"workflowId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"shipStationStatusFilters": [
"string"
],
"interval": "string"
}
UpdateBinLocationInput: object
The input variables for updating bin locations.
- id:
-
The numerical ID of the bin location.
- name:
-
The name of the bin location.
- labelIds:
-
The array of Label IDs associated with this bin location.
- customFields:
-
The array of Custom Field keys and values associated with this bin location.
Example
{
"id": "number",
"name": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
]
}
UpdateCostRuleInput: object
The input variables for updating cost rules.
- id:
-
The numerical ID of the cost rule.
- skuId:
-
The numerical ID of the SKU associated with this cost rule.
- vendorId:
-
The numerical ID of the Vendor associated with this cost rule.
- unit:
-
The unit associated with this cost (e.g., 'Pallet', 'Pack', 'Box')
- vendorPartNumber:
-
The vendor part number.
- quantity:
-
The quantity of units associated with this cost.
- cost:
-
The total cost of the unit (e.g., 500.00 for $500/Pallet).
Example
{
"id": "number",
"skuId": "number",
"vendorId": "number",
"unit": "string",
"vendorPartNumber": "string",
"quantity": "number",
"cost": "number"
}
UpdateCustomFieldInput: object
The input variables for updating custom fields.
- id:
-
The numerical ID of the custom field.
- sortOrder:
-
The numeric value you wish to sort by.
- name:
-
The name of the custom field (alpha-numeric, underscore-delimeted, e.g., 'alternative_name').
Example
{
"id": "number",
"sortOrder": "number",
"name": "string"
}
UpdateCustomerInput: object
The input variables for updating customers.
- id:
-
The numerical ID of the customer.
- altId:
-
The alternative ID of the customer.
- businessName:
-
The name of the customer.
- termId:
-
The numerical ID of the Term associated with this customer.
- taxExempt:
-
The field indicating whether or not the customer is exempt from sales tax.
- taxRate:
-
The tax rate (%) associated with this customer. Defaults to 0. Can be between 0 and 1 (0% - 100%).
- notes:
-
The notes on this customer.
- contactIds:
-
The array of Contact IDs associated with this customer.
- labelIds:
-
The array of Label IDs associated with this customer.
- customFields:
-
The array of Custom Field keys and values associated with this customer.
- addressIds:
-
The array of Address IDs associated with this customer.
Example
{
"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"
}
]
}
UpdateFilterInput: object
The input variables for updating filters.
- id:
-
The numerical ID of the filter.
- name:
-
The name of the filter.
- color:
-
The color of the filter.
- module:
-
The module that the filter belongs to.
- queryParams:
-
The JSON string containing the query parameters belonging to this filter.
Example
{
"id": "number",
"name": "string",
"color": "string",
"module": "string",
"queryParams": "string"
}
UpdateLabelInput: object
The input variables for updating labels.
- id:
-
The numerical ID of the label.
- name:
-
The name of the label.
- color:
-
The color of the label.
- modules:
-
The array of modules that this label will appear on.
Example
{
"id": "number",
"name": "string",
"color": "string",
"modules": [
"string"
]
}
UpdateLotInput: object
The input variables for updating lots.
- id:
-
The numerical ID of the sku.
- binId:
-
The numerical ID of the Bin Location associated with this lot.
- lotNumber:
-
The identifier of the lot.
- cost:
-
The cost per unit of inventory within the lot.
- altLotNumber:
-
The alternative identifier of the lot, for custom metadata.
- serialNumber:
-
The unique identifier of an individual piece of inventory.
- manufactureDate:
-
The date this piece of inventory was manufactured.
- expirationDate:
-
The date this piece of inventory expires.
Example
{
"id": "number",
"binId": "number",
"lotNumber": "string",
"cost": "number",
"altLotNumber": "string",
"serialNumber": "string",
"manufactureDate": "object",
"expirationDate": "object"
}
UpdateNotificationInput: object
The input variables for updating notifications.
- id:
-
The ID of the notification to update.
- message:
-
The text of the notification.
- userId:
-
The ID of the user to notify.
- type:
-
The type of notification.
- recordId:
-
The ID of the table record to reference in external links.
- hasBeenSeen:
-
The column indicating whether or not the notification has been seen.
Example
{
"id": "number",
"message": "string",
"userId": "number",
"type": "string",
"recordId": "number",
"hasBeenSeen": "boolean"
}
UpdatePriceRuleCriterionInput: object
The input variables for updating price rule criteria.
- id:
-
The numerical ID of the criterion.
- skuPriceId:
-
The ID of the price rule.
- labelId:
-
The ID of the label to match against.
- matchCriteria:
-
The criteria for matching the provided labels to the criteria labels.
Example
{
"id": "number",
"skuPriceId": "number",
"labelId": "number",
"matchCriteria": "string"
}
UpdatePriceRuleInput: object
The input variables for updating price rules.
- id:
-
The numerical ID of the price rule.
- skuId:
-
The numerical ID of the SKU associated with this price rule.
- unit:
-
The unit associated with this price (e.g., 'Pallet', 'Pack', 'Box')
- quantity:
-
The quantity of units associated with this price.
- price:
-
The total price of the unit (e.g., 500.00 for $500/Pallet).
Example
{
"id": "number",
"skuId": "number",
"unit": "string",
"quantity": "number",
"price": "number"
}
UpdateProductCategoryInput: object
The input variables for updating product categories.
- id:
-
The numerical ID of the product category.
- labelIds:
-
The array of Label IDs associated with this product category.
- subcategoryIds:
-
The array of Subcategory IDs associated with this product category.
- name:
-
The name of the product category.
- description:
-
The description of the product category.
- templateId:
-
The ID of the category template associated with this product category.
Example
{
"id": "number",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"subcategoryIds": [
{
"id": "number",
"remove": "boolean"
}
],
"name": "string",
"description": "string",
"templateId": "number"
}
UpdateProductInput: object
The input variables for updating products.
- id:
-
The numerical ID of the product.
- name:
-
The name of the product.
- displayId:
-
The alphanumeric ID that is displayed for this product.
- labelIds:
-
The array of Label IDs associated with this product.
- customFields:
-
The array of Custom Field keys and values associated with this product.
- description:
-
The description of the product.
- templateId:
-
The ID of the product template associated with this product.
Example
{
"id": "number",
"name": "string",
"displayId": "string",
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
],
"customFields": [
{
"id": "number",
"value": "string",
"remove": "boolean"
}
],
"description": "string",
"templateId": "number"
}
UpdatePurchaseOrderInput: object
The input variables for updating purchase orders.
- id:
-
The numerical ID of the purchase order.
- altId:
-
The alternative ID of the purchase order.
- warehouseId:
-
The numerical ID of the Warehouse associated with this purchase order.
- vendorId:
-
The numerical ID of the Vendor associated with this purchase order.
- statusId:
-
The numerical ID of the Status associated with this purchase order.
- notes:
-
The internal notes associated with this purchase order.
- externalNotes:
-
The notes intended for the vendor.
- issuedDate:
-
The date this purchase order was placed.
- dueDate:
-
The date that this purchase order is due.
- labelIds:
-
The array of Label IDs associated with this purchase order.
- customFields:
-
The array of Custom Field keys and values associated with this purchase order.
- lineItems:
-
The array of Line Items associated with this purchase order.
- receivements:
-
The array of Receivements associated with this purchase order.
- receipts:
-
The array of Receipts associated with this purchase order.
Example
{
"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",
"dueDate": "object"
}
]
}
UpdateSKUInput: object
The input variables for updating skus.
- id:
-
The numerical ID of the sku.
- isKit:
-
The flag for determining if the SKU is a kit or not.
- code:
-
The identifier of the sku (UPC, GTIN, etc).
- name:
-
The display name of the sku.
- productId:
-
The numerical ID of the Product associated with this sku.
- vendorIds:
-
The array of Vendor IDs associated with this sku.
- labelIds:
-
The array of Label IDs associated with this sku.
- files:
-
The array of File Mappings associated with this sku.
- billOfMaterials:
-
The Bill of Materials consumed by assembly of this sku.
- customFields:
-
The array of Custom Field keys and values associated with this sku.
- minStockLevel:
-
The minimum stock level for this sku.
- maxStockLevel:
-
The maximum stock level for this sku.
Example
{
"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"
}
UpdateSalesOrderInput: object
The input variables for updating sales orders.
- statusId:
-
The numerical ID of the Status associated with this sales order.
- originWarehouseId:
-
The numerical ID of the origin Warehouse associated with this sales order.
- id:
-
The numerical ID of the sales order.
- altId:
-
The alternative ID of the sales order.
- customerId:
-
The Customer associated with this sales order.
- labelIds:
-
The array of Label IDs associated with this sales order.
- userIds:
-
The array of User IDs associated with this sales order.
- customFields:
-
The array of Custom Field keys and values associated with this sales order.
- lineItems:
-
The array of Line Items associated with this sales order.
- shipments:
-
The Shipments associated with this sales order.
- returns:
-
The Returns associated with this sales order.
- payments:
-
The Payments associated with this sales order.
- invoices:
-
The Invoices associated with this sales order.
- notes:
-
The internal notes on this sales order.
- externalNotes:
-
The external notes on this sales order.
- shipDate:
-
The date this order was shipped.
- cancelByDate:
-
The date that this order should be canceled by.
- customerPo:
-
The Customer PO Number.
- billingAddressId:
-
The numerical ID of the Billing Address.
- shippingAddressId:
-
The numerical ID of the Shipping Address.
- openDate:
-
The DateTime when the sales order was marked as placed.
Example
{
"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",
"remove": "boolean"
}
]
}
]
}
]
}
]
}
UpdateTemplateInput: object
The input variables for updating templates.
- id:
-
The numerical ID of the template.
- isConsolidated:
-
The flag to determine whether or not this is a consolidated template.
- guestMode:
-
The flag to determine whether or not this template is publicly accessible in the storefront.
- projectId:
-
The numerical ID of the Project associated with this template.
- fileName:
-
The file name.
- html:
-
The html of the template.
- type:
-
The template type.
- subtype:
-
The template subtype.
- files:
-
The array of File Mappings associated with this template.
Example
{
"id": "number",
"isConsolidated": "boolean",
"guestMode": "boolean",
"projectId": "number",
"fileName": "string",
"html": "string",
"type": "string",
"subtype": "string",
"files": [
{
"id": "number",
"name": "string",
"sortOrder": "number",
"remove": "boolean"
}
]
}
UpdateTransferInput: object
The input variables for updating transfers.
- id:
-
The numerical ID of the transfer.
- altId:
-
The alternative ID of the transfer.
- originWarehouseId:
-
The numerical ID of the origin Warehouse associated with this transfer.
- destinationWarehouseId:
-
The numerical ID of the origin Warehouse associated with this transfer.
- statusId:
-
The numerical ID of the Status associated with this transfer.
- notes:
-
The internal notes associated with this transfer.
- externalNotes:
-
The notes intended for the vendor.
- issuedDate:
-
The date this transfer was placed.
- dueDate:
-
The date that this transfer is due.
- labelIds:
-
The array of Label IDs associated with this transfer.
- customFields:
-
The array of Custom Field keys and values associated with this transfer.
- lineItems:
-
The array of Line Items associated with this transfer.
- receivements:
-
The array of Receivements associated with this transfer. Transfer receivements are associated with a single lot. If you create a receivement that encompases more than one lot, the API will automatically create multiple receivements.
Example
{
"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"
}
]
}
UpdateUserInput: object
The input variables for updating users.
- id:
-
The numerical ID of the user.
- hasTakenTour:
-
The flag for whether or not the user has taken the app tour.
- username:
-
The name of the user.
- roleSlug:
-
The slug for the user's role (e.g., admin).
- isActive:
-
The field indicating whether or not a user is active. A user cannot log in if they are inactive.
- email:
-
The email address of the user.
- password:
-
The password for user authentication.
- profile:
-
The object containing all of the fields for a particular user's profile.
- labelIds:
-
The array of Label IDs associated with this user.
Example
{
"id": "number",
"hasTakenTour": "boolean",
"username": "string",
"roleSlug": "string",
"isActive": "boolean",
"email": "string",
"password": "string",
"profile": {
"firstName": "string",
"lastName": "string"
},
"labelIds": [
{
"id": "number",
"remove": "boolean"
}
]
}
UpdateUserRoleInput: object
The input variables for creating user roles.
- id:
-
The numerical ID of the user role.
- displayName:
-
The display name of the user role (e.g., Admin).
- slug:
-
The unique slug of the user role (e.g., admin). Will self-generate if left blank.
- routeBlacklist:
-
An array of routes to blacklist for this user role.
- scopeBlacklist:
-
An array of API scopes to blacklist for this user role.
Example
{
"id": "number",
"displayName": "string",
"slug": "string",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
]
}
UpdateVendorInput: object
The input variables for updating vendors.
- id:
-
The numerical ID of the vendor.
- name:
-
The name of the vendor.
- contactIds:
-
The array of Contact IDs associated with this vendor.
- labelIds:
-
The array of Label IDs associated with this vendor.
- customFields:
-
The array of Custom Field keys and values associated with this vendor.
- addressIds:
-
The array of Address IDs associated with this vendor.
- skuIds:
-
The array of SKU IDs associated with this vendor.
Example
{
"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"
}
]
}
UpdateWarehouseInput: object
The input variables for updating warehouses.
- id:
-
The numerical ID of the warehouse.
- name:
-
The name of the warehouse.
- contactIds:
-
The array of Contact IDs associated with this warehouse.
- labelIds:
-
The array of Label IDs associated with this warehouse.
- addressIds:
-
The array of Address IDs associated with this warehouse.
- customFields:
-
The array of Custom Field keys and values associated with this warehouse.
Example
{
"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"
}
]
}
UpdateWorkOrderInput: object
The input variables for updating work orders.
- id:
-
The numerical ID of the work order.
- altId:
-
The alternative ID of the work order.
- originWarehouseId:
-
The numerical ID of the Warehouse associated with this work order.
- statusId:
-
The numerical ID of the Status associated with this work order.
- notes:
-
The internal notes associated with this work order.
- externalNotes:
-
The notes intended for the vendor.
- labelIds:
-
The array of Label IDs associated with this work order.
- customFields:
-
The array of Custom Field keys and values associated with this work order.
- lineItems:
-
The array of Line Items associated with this work order.
- assemblies:
-
The array of Assemblies associated with this work order.
- startOn:
-
The date this work order was started.
- dueDate:
-
The date that this work order is due.
Example
{
"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"
}
UpdateWorkflowActionInput: object
The input variables for updating workflow actions.
- id:
-
The numerical ID of the action.
- workflowId:
-
The ID of the workflow.
- type:
-
The type of action.
- labelId:
-
The label id to apply for APPLY_LABEL and REMOVE_LABEL actions.
- emailSettings:
-
The configuration for SEND_EMAIL actions.
- purchaseOrderSettings:
-
The configuration for PURCHASE_ORDER actions.
Example
{
"id": "number",
"workflowId": "number",
"type": "string",
"labelId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"purchaseOrderSettings": {
"warehouseId": "number",
"statusId": "number"
}
}
UpdateWorkflowCriterionInput: object
The input variables for updating workflow criteria.
- id:
-
The numerical ID of the criterion.
- workflowId:
-
The ID of the workflow.
- triggerCondition:
-
The condition for triggering the criterion.
- testTable:
-
The table being evaluated in the workflow trigger.
- testSubTable:
-
The subtable being evaluated in the workflow trigger.
- testColumn:
-
The column on the table being evaluated in the workflow trigger.
- testValue:
-
The test value being evaluated in the workflow trigger.
- testValueColumn:
-
The value of the test column being evaluated in the workflow trigger.
- useValueColumn:
-
The flag to determine whether or not 'testValue' or 'testValueColumn' is evaluated.
- compareLastValues:
-
The flag to determine whether or not to compare the last values from workflow evaluation. If these values are the same, the workflow will not trigger again.
- matchCriteria:
-
The criteria for matching the value to the indicated column.
Example
{
"id": "number",
"workflowId": "number",
"triggerCondition": "string",
"testTable": "string",
"testSubTable": "string",
"testColumn": "string",
"testValue": "string",
"testValueColumn": "string",
"useValueColumn": "boolean",
"compareLastValues": "boolean",
"matchCriteria": "string"
}
User: object
The object containing all of the fields for a particular user.
- id:
-
The numerical ID of the user.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this user.
- username:
-
The name of the user.
- role:
-
The object containing all of the fields for a particular user's role.
- isActive:
-
The field indicating whether or not a user is active. A user cannot log in if they are inactive.
- email:
-
The email address of the user.
- profile:
-
The object containing all of the fields for a particular user's profile.
- labels:
-
The array of Labels associated with this user.
- hasTakenTour:
-
The flag for whether or not the user has taken the app tour.
- createdAt:
-
The DateTime when the user was created.
- updatedAt:
-
The DateTime when the user was updated.
Example
{
"id": "number",
"accountId": "number",
"username": "string",
"role": {
"id": "number",
"slug": "string",
"displayName": "string",
"isActive": "boolean",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
},
"isActive": "boolean",
"email": "string",
"profile": {
"firstName": "string",
"lastName": "string",
"fullName": "string"
},
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"hasTakenTour": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
UserPayload: object
The return type for user queries and mutations.
- user:
Example
{
"user": {
"id": "number",
"accountId": "number",
"username": "string",
"role": {
"id": "number",
"slug": "string",
"displayName": "string",
"isActive": "boolean",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
},
"isActive": "boolean",
"email": "string",
"profile": {
"firstName": "string",
"lastName": "string",
"fullName": "string"
},
"labels": [
{
"id": "number",
"accountId": "number",
"name": "string",
"color": "string",
"modules": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
],
"hasTakenTour": "boolean",
"createdAt": "string",
"updatedAt": "string"
}
}
UserRole: object
The object containing all of the fields for a particular user role.
- id:
-
The numerical ID of the role.
- slug:
-
The unique string identifier of the user role (e.g., admin).
- displayName:
-
The display name of the role (e.g., Admin).
- isActive:
-
The field indicating whether or not a role is active.
- routeBlacklist:
-
The routes this role is prevented from accessing.
- scopeBlacklist:
-
The API scopes this role is prevented from accessing.
- createdAt:
-
The DateTime when the user role was created.
- updatedAt:
-
The DateTime when the user role was updated.
Example
{
"id": "number",
"slug": "string",
"displayName": "string",
"isActive": "boolean",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
UserRolePayload: object
The return type for user role queries and mutations.
- role:
Example
{
"role": {
"id": "number",
"slug": "string",
"displayName": "string",
"isActive": "boolean",
"routeBlacklist": [
"string"
],
"scopeBlacklist": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
}
Vendor: object
The object containing all of the fields for a particular vendor.
- id:
-
The numerical ID of the vendor.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this vendor.
- name:
-
The name of the vendor.
- contacts:
-
The Contacts associated with this vendor.
- addresses:
-
The Addresses associated with this vendor.
- labels:
-
The Labels associated with this vendor.
- customFields:
-
The array of Custom Fields associated with this vendor.
- quickBooksId:
-
The QuickBooks ID associated with this vendor.
- quickBooksSyncToken:
-
The QuickBooks sync token associated with this vendor.
- skus:
-
The SKUs associated with this vendor.
- createdAt:
-
The DateTime when the vendor was created.
- updatedAt:
-
The DateTime when the vendor was updated.
Example
{
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "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"
}
],
"quickBooksId": "number",
"quickBooksSyncToken": "string",
"skus": [
{
"id": "number",
"accountId": "number",
"productId": "number",
"code": "string"
}
]
}
VendorPayload: object
The return type for vendor queries and mutations.
- vendor:
-
The Vendor object.
Example
{
"vendor": {
"id": "number",
"accountId": "number",
"name": "string",
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "string"
}
],
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "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"
}
],
"quickBooksId": "number",
"quickBooksSyncToken": "string",
"skus": [
{
"id": "number",
"accountId": "number",
"productId": "number"
}
]
}
}
Warehouse: object
The object containing all of the fields for a particular warehouse.
- id:
-
The numerical ID of the warehouse.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this warehouse.
- name:
-
The name of the warehouse.
- addresses:
-
The addresses associated with this warehouse.
- contacts:
-
The Contacts associated with this warehouse.
- labels:
-
The labels associated with this warehouse.
- customFields:
-
The array of Custom Fields associated with this warehouse.
- createdAt:
-
The DateTime when the warehouse was created.
- updatedAt:
-
The DateTime when the warehouse was updated.
Example
{
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string",
"updatedAt": "string"
}
WarehousePayload: object
The return type for warehouse queries and mutations.
- warehouse:
-
The Warehouse object.
Example
{
"warehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string",
"updatedAt": "string"
}
}
WorkOrder: object
The object containing all of the fields for a particular work order.
- id:
-
The numerical ID of the work order.
- displayId:
-
The display ID of the work order.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this work order.
- altId:
-
The alternative ID of the work order.
- originWarehouseId:
-
The numerical ID of the Warehouse associated with this work order.
- originWarehouse:
-
The Warehouse associated with this work order.
- statusId:
-
The numerical ID of the Status associated with this work order.
- notes:
-
The internal notes associated with this work order.
- externalNotes:
-
The notes intended for the assembly team.
- labels:
-
The Labels associated with this work order.
- customFields:
-
The array of Custom Fields associated with this work order.
- lineItems:
-
The Line Items associated with this work order.
- assemblies:
-
The Assemblies associated with this work order.
- startOn:
-
The date this work order was started.
- dueDate:
-
The date that this work order is due.
- createdAt:
-
The DateTime when the work order was created.
- updatedAt:
-
The DateTime when the work order was updated.
Example
{
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string",
"updatedAt": "string"
}
}
WorkOrderLineItem: object
The object containing all of the fields for a particular line item on work orders.
- id:
-
The numerical ID of the Line Item to be assembled.
- skuId:
-
The numerical ID of the SKU associated with this line item.
- quantity:
-
The quantity being assembled.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- billOfMaterials:
-
The Bill of Materials consumed by assembly.
Example
{
"id": "number",
"skuId": "number",
"quantity": "number",
"name": "string",
"description": "string",
"billOfMaterials": [
{
"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"
}
]
}
]
}
]
}
WorkOrderLineItemInput: object
The input variables for creating line item on work orders.
- id:
-
The numerical ID of the Line Item to be assembled.
- quantity:
-
The quantity being assembled.
- name:
-
The name of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- description:
-
The description of the SKU that will appear on the Receipts, Invoices, etc. associated with this line item.
- billOfMaterials:
-
The Bill of Materials consumed by assembly.
- remove:
-
The field for removing the line item if set to true.
Example
{
"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"
}
WorkOrderPayload: object
The return type for work order queries and mutations.
- workOrder:
-
The Work Order object.
Example
{
"workOrder": {
"id": "number",
"displayId": "number",
"accountId": "number",
"altId": "string",
"originWarehouseId": "number",
"originWarehouse": {
"id": "number",
"accountId": "number",
"name": "string",
"addresses": [
{
"id": "number",
"accountId": "number",
"name": "string",
"fullAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"postalCode": "string",
"city": "string",
"district": "string",
"country": "string"
}
],
"contacts": [
{
"id": "number",
"accountId": "number",
"name": "string",
"phone": "string",
"email": "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"
}
],
"createdAt": "string"
}
}
}
Workflow: object
The object containing all of the fields for a particular workflow.
- id:
-
The numerical ID of the workflow.
- isPaused:
-
The flag that determines whether or not the process will run.
- displayId:
-
The display ID of the workflow.
- accountId:
-
The numerical ID of the 'Lead Commerce' Account associated with this workflow.
- workflowCriteria:
-
The list of workflow criteria.
- workflowActions:
-
The list of workflow actions.
- name:
-
The name of the workflow.
- createdAt:
-
The DateTime when the workflow was created.
- updatedAt:
-
The DateTime when the workflow was updated.
Example
{
"id": "number",
"isPaused": "boolean",
"displayId": "string",
"accountId": "number",
"workflowCriteria": [
{
"id": "number",
"workflowId": "number",
"triggerCondition": "string",
"testTable": "string",
"testSubTable": "string",
"testColumn": "string",
"testValue": "string",
"testValueColumn": "string",
"useValueColumn": "boolean",
"compareLastValues": "boolean",
"matchCriteria": "string"
}
],
"workflowActions": [
{
"id": "number",
"type": "string",
"workflowId": "number",
"labelId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"purchaseOrderSettings": {
"warehouseId": "number",
"statusId": "number"
}
}
],
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}
WorkflowAction: object
The object containing all of the fields for a particular workflow action.
- id:
-
The numerical ID of the action.
- type:
-
The type of action.
- workflowId:
-
The ID of the workflow.
- labelId:
-
The label id to apply in APPLY_LABEL and REMOVE_LABEL actions.
- emailSettings:
-
The configuration for SEND_EMAIL actions.
- purchaseOrderSettings:
-
The configuration for PURCHASE_ORDER actions.
Example
{
"id": "number",
"type": "string",
"workflowId": "number",
"labelId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"purchaseOrderSettings": {
"warehouseId": "number",
"statusId": "number"
}
}
WorkflowActionPayload: object
The return type for workflow action queries and mutations.
- workflowAction:
-
The Workflow Action object.
Example
{
"workflowAction": {
"id": "number",
"type": "string",
"workflowId": "number",
"labelId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"purchaseOrderSettings": {
"warehouseId": "number",
"statusId": "number"
}
}
}
WorkflowActionType: string
The options for workflow action types.
-
objectAPPLY_LABEL
-
The workflow action for applying a label to a record when criteria is met.
-
objectREMOVE_LABEL
-
The workflow action for removing a label from a record when criteria is met.
-
objectSEND_EMAIL
-
The workflow action for sending an email when criteria is met.
-
objectINVOICE
-
The workflow action for automatically generating invoices for sales orders. Only applicable to the Sales Orders module.
-
objectSHIPMENT
-
The workflow action for automatically generating shipments for sales orders. Only applicable to the Sales Orders module.
-
objectPURCHASE_ORDER
-
The workflow action for automatically generating purchase orders for skus. Only applicable to the SKUs module.
WorkflowCriterion: object
The object containing all of the fields for a particular workflow criterion.
- id:
-
The numerical ID of the criterion.
- workflowId:
-
The ID of the workflow.
- triggerCondition:
-
The condition for triggering the criterion.
- testTable:
-
The table being evaluated in the workflow trigger.
- testSubTable:
-
The subtable being evaluated in the workflow trigger.
- testColumn:
-
The column on the table being evaluated in the workflow trigger.
- testValue:
-
The test value being evaluated in the workflow trigger.
- testValueColumn:
-
The value of the test column being evaluated in the workflow trigger.
- useValueColumn:
-
The flag to determine whether or not 'testValue' or 'testValueColumn' is evaluated.
- compareLastValues:
-
The flag to determine whether or not to compare the last values from workflow evaluation. If these values are the same, the workflow will not trigger again.
- matchCriteria:
-
The criteria for matching the value to the indicated column.
Example
{
"id": "number",
"workflowId": "number",
"triggerCondition": "string",
"testTable": "string",
"testSubTable": "string",
"testColumn": "string",
"testValue": "string",
"testValueColumn": "string",
"useValueColumn": "boolean",
"compareLastValues": "boolean",
"matchCriteria": "string"
}
WorkflowCriterionPayload: object
The return type for workflow criteria queries and mutations.
- workflowCriterion:
-
The Workflow Criterion object.
Example
{
"workflowCriterion": {
"id": "number",
"workflowId": "number",
"triggerCondition": "string",
"testTable": "string",
"testSubTable": "string",
"testColumn": "string",
"testValue": "string",
"testValueColumn": "string",
"useValueColumn": "boolean",
"compareLastValues": "boolean",
"matchCriteria": "string"
}
}
WorkflowCriterionTestSubTable: string
-
objectCUSTOMER_LABELS
-
objectPURCHASE_ORDER_LABELS
-
objectSALES_ORDER_LABELS
-
objectSKU_LABELS
-
objectTRANSFER_LABELS
-
objectWORK_ORDER_LABELS
WorkflowCriterionTestTable: string
-
objectCUSTOMERS
-
objectPURCHASE_ORDERS
-
objectSALES_ORDERS
-
objectSKUS
-
objectTRANSFERS
-
objectWORK_ORDERS
WorkflowMatchCriteria: string
The options for workflow criteria matching.
-
objectGREATER_THAN
-
Matches if the column value is greater than the test value.
-
objectGREATER_THAN_OR_EQUAL
-
Matches if the column value is greater than or equal to the test value.
-
objectLESS_THAN
-
Matches if the column value is less than the test value.
-
objectLESS_THAN_OR_EQUAL
-
Matches if the column value is less than or equal to the test value.
-
objectEQUALS
-
Matches if the column value is equal to the test value.
-
objectNOT_EQUALS
-
Matches if the column value is not equal to the test value.
-
objectLIKE
-
Matches if the column value is similar to the test value (e.g., 'TEST' will match 'test').
-
objectCONTAINS
-
Matches if the column value contains a substring (e.g., 'TEST' will match 'S').
-
objectNOT_CONTAINS
-
Matches if the column value does not contain a substring (e.g., 'TEST' will NOT match 'S').
-
objectARRAY_CONTAINS
-
Matches if the column value in the subtable array contains a value (e.g., [1, 2, 3] contains 1).
-
objectARRAY_DOES_NOT_CONTAIN
-
Matches if the column value in the subtable array does not contain a value (e.g., [1, 2, 3] does not contain 4).
WorkflowPayload: object
The return type for workflow queries and mutations.
- workflow:
-
The Workflow object.
Example
{
"workflow": {
"id": "number",
"isPaused": "boolean",
"displayId": "string",
"accountId": "number",
"workflowCriteria": [
{
"id": "number",
"workflowId": "number",
"triggerCondition": "string",
"testTable": "string",
"testSubTable": "string",
"testColumn": "string",
"testValue": "string",
"testValueColumn": "string",
"useValueColumn": "boolean",
"compareLastValues": "boolean",
"matchCriteria": "string"
}
],
"workflowActions": [
{
"id": "number",
"type": "string",
"workflowId": "number",
"labelId": "number",
"emailSettings": {
"templateId": "number",
"subject": "string",
"replyTo": "string",
"to": "string",
"bcc": "string"
},
"purchaseOrderSettings": {
"warehouseId": "number",
"statusId": "number"
}
}
],
"name": "string",
"createdAt": "string",
"updatedAt": "string"
}
}