MGR API EXPLORER

Resources/Endpoints:

SHOP

UserMember DELETE PATCH PUT POST GET /users/{userId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

UserCollection DELETE PATCH PUT POST GET /users

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in First Name,Last Name,Email,Type,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional name (default: "")
Staff Name
optional mobile (default: "")
Staff Mobile
optional phone (default: "")
Staff Telephone
optional email (default: "")
Staff Email Address
optional address (default: "")
Staff Address
optional website (default: "")
Staff Website
optional gender (default: "")
Female,Male
optional type (default: "")
Staff Type
optional status (default: "")
Active,In active

TaxRateCollection DELETE PATCH PUT POST GET /taxRates

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional searchKeyword (default: "")
Search in Name,Code,Valu,Type

PaymentMethodCollection DELETE PATCH PUT POST GET /paymentMethods

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in title,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy

Info DELETE PATCH PUT POST GET /info

Request Body:

Loading...

Response:

get

APPOINTMENTS

Member DELETE PATCH PUT POST GET /appointments/{appointmentId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
delete
put
optional string subject
Appointment Subject. Maximum length is 100 characters.
optional string description
Appointment Description.
optional string type
Valid Options are: InShop,OnSite,PhoneCall
optional string color
Appointment Color.
optional string location
Appointment location.
optional string latitude
Appointment location latitude.
optional string longitude
Appointment location longitude.
optional string ticket
Valid {ticketId}. Get valid list of tickets via tickets/tickets endpoint
optional string customer
Valid {customer_id}. Get valid list of customers via customers/customers endpoint
optional string leads
Valid {leadId}. Get valid list of leads via leads/leads endpoint
optional date dateandtime
Appointment Date and time. Format: dd-mmm-yyyy HH:mm
optional numeric duration
Appointment Duration (In Minutes)
optional string attendees
Valid {userId OR userIds (comma separated)}. Get valid list of users via shop/user endpoint

Collection DELETE PATCH PUT POST GET /appointments

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Subject,Description,Appointment Type,Appointment Location,Appointment Date,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional startDateFrom (default: "")
dd-mmm-yyyy
optional startDateTo (default: "")
dd-mmm-yyyy
optional endDateFrom (default: "")
dd-mmm-yyyy
optional endDateTo (default: "")
dd-mmm-yyyy
optional ticket (default: "")
Search in id,ticket number,short info
optional customer (default: "")
Search in id,customer name,mobile,email
optional lead (default: "")
Search in id,name,company,telephone,mobile,email
optional attendee (default: "")
Search in id,first name,last name
optional type (default: "")
InShop,OnSite,PhoneCall
post
required string subject
Appointment Subject. Maximum length is 100 characters.
optional string description
Appointment Description.
optional string type
Valid Options are: InShop,OnSite,PhoneCall
optional string color
Appointment Color.
optional string location
Appointment location.
optional string latitude
Appointment location latitude.
optional string longitude
Appointment location longitude.
optional string ticket
Valid {ticketId}. Get valid list of tickets via tickets/tickets endpoint
optional boolean createticket (default: false)
Valid options are: True/False, Yes/No, 1/0
optional string presetId
Valid {presetId}.Get valid list of presets via tickets/presets endpoint.
optional string customer
Valid {customer_id}. Get valid list of customers via customers/customers endpoint
optional string leads
Valid {leadId}. Get valid list of leads via leads/leads endpoint
required date dateandtime
Appointment Date and time. Format: dd-mmm-yyyy HH:mm
required numeric duration (default: 10)
Appointment Duration (In Minutes)
optional string attendees
Valid {userId OR userIds (comma separated)}. Get valid list of users via shop/user endpoint

CUSTOMERS

Member DELETE PATCH PUT POST GET /customers/{customerId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
delete
put
optional string name
Customer Name. Maximum length is 250 characters.
optional string company
Customer Company Name
optional string VATRegistration
VAT Registration Number
optional string email
Customer email
optional string invoiceemail
Customer invoice email (If different than email)
optional string telephone
Customer telephone
optional string mobile
Customer mobile
optional string address
Customer full address
optional string city
Customer city
optional string countryCode
Customer country code i.e UK
optional date dateOfBirth
Customer Date of birth. Format: dd-mmm-yyyy
optional string group
Customer group name
optional string latitude
Customer latitude
optional string longitude
Customer longitude
optional string gender
Female,Male,Not Specified
optional string referredBy
[runtime expression]
optional string accountManager
Account Manager Name
optional numeric paymentTermDays (default: 0)
Payment Term Days
optional string comments
Customer Profile
optional boolean gdprCompliant
Valid options are: True/False, Yes/No, 1/0
optional boolean subSmsService
Valid options are: True/False, Yes/No, 1/0
optional boolean subPrintMedia
Valid options are: True/False, Yes/No, 1/0
optional boolean subEmailMarketing
Valid options are: True/False, Yes/No, 1/0
optional boolean subEmailNotifications
Valid options are: True/False, Yes/No, 1/0
optional boolean IntraCommunity
Valid options are: True/False, Yes/No, 1/0

Collection DELETE PATCH PUT POST GET /customers

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Name,Company,Mobile,Telephone,Address,City,Date_Created
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional name (default: "")
Customer Name
optional mobile (default: "")
Customer Mobile
optional phone (default: "")
Customer Telephone
optional company (default: "")
Customer Company
optional email (default: "")
Customer Email Address
optional invoiceemail (default: "")
Customer invoice Email Address
optional address (default: "")
Customer Address
optional city (default: "")
Customer City
optional group (default: "")
Customer Group
optional gender (default: "")
Female,Male,Not Specified
optional type (default: "")
Customer Type
optional boolean includeCustomFields (default: false)
When true, custom fields object will be included if customer has data for at least one custom field.
post
required string name
Customer Name. Maximum length is 250 characters.
optional string company
Customer Company Name
optional string VATRegistration
VAT Registration Number
optional string email
Customer email
optional string invoiceemail
Customer invoice email (If different than email)
optional string telephone
Customer telephone
optional string mobile
Customer mobile
optional string address
Customer full address
optional string city
Customer city
optional string countryCode
Customer country code i.e UK
optional date dateOfBirth
Customer Date of birth. Format: dd-mmm-yyyy
optional string group
Customer group name
optional string latitude
Customer latitude
optional string longitude
Customer longitude
optional string gender
Female,Male,Not Specified
optional string referredBy
[runtime expression]
optional string accountManager
Account Manager Name
optional numeric paymentTermDays (default: 0)
Payment Term Days
optional string comments
Customer Profile
optional boolean gdprCompliant
Valid options are: True/False, Yes/No, 1/0
optional boolean subSmsService
Valid options are: True/False, Yes/No, 1/0
optional boolean subPrintMedia
Valid options are: True/False, Yes/No, 1/0
optional boolean subEmailMarketing
Valid options are: True/False, Yes/No, 1/0
optional boolean subEmailNotifications
Valid options are: True/False, Yes/No, 1/0
optional boolean IntraCommunity
Valid options are: True/False, Yes/No, 1/0

TICKETS

MemberUploadDoc DELETE PATCH PUT POST GET /tickets/{ticketId}/upload

URI Tokens: (required)

Request Body:

Loading...

Response:

put
post
required string fileName
required numeric fileSize
optional string fileTitle (default: "")
optional string displayType (default: Public)

ItemLines DELETE PATCH PUT POST GET /tickets/{ticketId}/itemLines

URI Tokens: (required)

Request Body:

Loading...

Response:

get

Member DELETE PATCH PUT POST GET /tickets/{ticketId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
delete
put
optional string customerId
optional string shortInfo
optional any status (default: New)
Valid {statusId} or {statusLabel} of a type 'repair'. In case of {statusLabel}, value must be an exact match, otherwise the resource will return error. Get valid list of statuses via /statuses endpoint
optional any issueType
Valid {issueTypeId} or {issueTypeLabel}. In case of {issueTypeLabel}, value must be an exact match, otherwise the resource will return error. Get valid list of issue types via /issuetypes endpoint
optional numeric deviceModelId
Get via /models endpoint
optional string dueDate
Provide date in 'dd-mmm-yyyy' format
optional string userId
Get via /staffs endpoint
optional numeric tax
Zero or any positive number.
optional numeric discount
Zero or any positive number.
optional string discountLevel
Valid options are: gross, grand.
optional boolean customerGroupDiscount
Override custom group discount if it's present. True: works just like default, if the customer group discount is applicable by ignoring the supplied {discount} and {discountLevel} values. False: will ignore customer group discount and insted use the supplied {discount} and {discountLevel} value.
optional string presetId
Get via /presets endpoint. This parameter is ignored if {lines} parameter is specified.
optional array lines
Ticket item lines to be added or updated in the ticket. This array will contain products with following parameters:
---- required string productCode
---- required numeric quantity
---- optional numeric unitPrice
---- optional string itemDescription
If a productCode exists already in the ticket, it will be updated with supplied values.
Example JSON
{
   ....
   "lines": [
      {
         "productCode": "PRD12345",
         "quantity": 1,
         "unitPrice": 25,
         "itemDescription": "Custom Product Description"
      },
      {
         "productCode": "PRD67890",
         "quantity": 1
      }
   ]
}

Collection DELETE PATCH PUT POST GET /tickets

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
Possible options: newest, oldest, recently_updated
optional searchKeyword (default: "")
Search in Short Info, Comments
optional ticketNo (default: "")
Search by ticket number without prefix.
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional updatedDateFrom (default: "")
dd-mmm-yyyy
optional updatedDateTo (default: "")
dd-mmm-yyyy
optional customer (default: "")
Customer Name
optional company (default: "")
Customer Company
optional issue (default: "")
Short Info
optional issueType (default: "")
Valid {issueTypeId} or {issueTypeLabel}. In case of {issueTypeLabel}, value must be an exact match. Get valid list of issue types via /issuetypes endpoint
optional issueTypeCondition (default: EQUAL)
Valid options EQUAL, NOT-EQUAL. Default is EQUAL
optional status (default: "")
Valid {statusId} or {statusLabel} of a type 'repair'. In case of {statusLabel}, value must be an exact match. Get valid list of statuses via /statuses endpoint
optional statusCondition (default: EQUAL)
Valid options EQUAL, NOT-EQUAL. Default is EQUAL
optional boolean includeLines (default: false)
Ticket item lines will be included if set to true.
optional boolean includePayments (default: false)
Payments object will be included if ticket has an invoice paid fully or partially.
optional boolean includeCustomFields (default: false)
When true, custom fields object will be included if ticket has data for at least one custom field.
post
required string customerId
A valid customer uuid, or a valid customer name.
required string shortInfo
optional any status (default: New)
Valid {statusId} or {statusLabel} of a type 'repair'. In case of {statusLabel}, value must be an exact match, otherwise the resource will return error. Get valid list of statuses via /statuses endpoint.
optional string issueDescription (default: "")
optional any issueType
Valid {issueTypeId} or {issueTypeLabel}. In case of {issueTypeLabel}, value must be an exact match, otherwise the resource will return error. Get valid list of issue types via /issuetypes endpoint.
optional numeric deviceModelId
Get via /models endpoint
optional string createdDate
Provide date in 'dd-mmm-yyyy' format
optional string dueDate
Provide date in 'dd-mmm-yyyy' format
optional string userId
Get via /staffs endpoint
optional boolean workApproved (default: false)
Ticket will be set as work approved intially, if true.
optional boolean preDiagnosed (default: false)
Ticket will be set as pre diagnosed intially, if true.
optional numeric tax
Zero or any positive number.
optional numeric discount
Zero or any positive number.
optional string discountLevel
Valid options are: gross, grand.
optional boolean customerGroupDiscount
Override custom group discount if it's present. True: works just like default, if the customer group discount is applicable by ignoring the supplied {discount} and {discountLevel} values. False: will ignore customer group discount and insted use the supplied {discount} and {discountLevel} value.
optional string presetId
Get via /presets endpoint. This parameter is ignored if {lines} parameter is specified.
optional array lines
Ticket item lines to be added in the ticket. This array will contain products with following parameters:
---- required string productCode
---- required numeric quantity
---- optional numeric unitPrice
---- optional string itemDescription
Example JSON
{
   ....
   "lines": [
      {
         "productCode": "PRD12345",
         "quantity": 1,
         "unitPrice": 25,
         "itemDescription": "Custom Product Description"
      },
      {
         "productCode": "PRD67890",
         "quantity": 1
      }
   ]
}

Comments DELETE PATCH PUT POST GET /ticketComments

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
Possible options: newest, oldest, recently_updated
optional string ticketId
The ticket id of which the comments to be retrieved. {id} in /tickets endpoint.
optional string type
Valid options are public, private.

StatusCollection DELETE PATCH PUT POST GET /statuses

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Status, Type
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional type (default: "")
Repair, Repair Notes
optional status (default: "")
Status

PresetMember DELETE PATCH PUT POST GET /presets/{presetId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

PresetsCollection DELETE PATCH PUT POST GET /presets

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in preset name
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional category (default: "")
Valid {presetCategoryId} or {presetCategoryName}. In case of {presetCategoryName}, value must be an exact match. Get valid list of preset categories via /presetCategories endpoint
optional brand (default: "")
Valid {brandId} or {brandName}. In case of {brandName}, value must be an exact match. Get valid list of issue types via /brands endpoint
optional model (default: "")
Valid {modelId} or {modelName}. In case of {modelName}, value must be an exact match. Get valid list of issue types via /models endpoint
optional issueType (default: "")
Valid {issueTypeId} or {issueTypeLabel}. In case of {issueTypeLabel}, value must be an exact match. Get valid list of issue types via /issueTypes endpoint
optional legalDocument (default: "")
Legal Document Id

PresetCategoryCollection DELETE PATCH PUT POST GET /presetCategories

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: oldest)
optional searchKeyword (default: "")
Search in preset category name
optional name (default: "")
Exact match with preset category name

IssueTypeCollection DELETE PATCH PUT POST GET /issueTypes

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in issue
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional label (default: "")
Issue

INVOICES

TicketMember DELETE PATCH PUT POST GET /ticketInvoices/{invoiceId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

TicketCollection DELETE PATCH PUT POST GET /ticketInvoices

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional boolean includePayments (default: false)
Payments will be included if true.
optional boolean includeLines (default: false)
Ticket item lines will be included if true.
optional boolean includeReturns (default: false)
Return object will be included if true.
optional searchKeyword (default: "")
Search in ticket_short_info, notes, customer.name
optional createdDateFrom (default: "")
Date in format 'dd-mmm-yyyy'
optional createdDateTo (default: "")
Date in format 'dd-mmm-yyyy'
optional invoiceNo (default: "")
Matches with the field 'invoice_no'
optional ticketNo (default: "")
Matches with the field 'ticket_no'
optional status (default: "")
Status of invoice. Possible values {Paid, Due}
optional paymentDateFrom (default: "")
Date in format 'dd-mmm-yyyy'
optional paymentDateTo (default: "")
Date in format 'dd-mmm-yyyy'

PosMember DELETE PATCH PUT POST GET /posOrders/{orderId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

PosCollection DELETE PATCH PUT POST GET /posOrders

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional boolean includePayments (default: false)
Payments will be included if true.
optional boolean includeLines (default: false)
Order item lines will be included if true.
optional boolean includeReturns (default: false)
Return object will be included if true.
optional searchKeyword (default: "")
Search in notes, customer.name
optional createdDateFrom (default: "")
Date in format 'dd-mmm-yyyy'
optional createdDateTo (default: "")
Date in format 'dd-mmm-yyyy'
optional orderNo (default: "")
Matches with the field 'order_no'
optional status (default: "")
Status of invoice. Possible values {Paid, Due}

PaymentsCollection DELETE PATCH PUT POST GET /payments

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional string invoiceId (default: "")
Ticket invoice id or a list of invoice ids
optional string orderId (default: "")
POS order id or a list of order ids
optional string filter (default: "")
Possible options: pos, invoice, return. Ignored if {invoice_id}
optional paymentDateFrom (default: "")
Date in format 'dd-mmm-yyyy'
optional paymentDateTo (default: "")
Date in format 'dd-mmm-yyyy'
optional boolean includeResource (default: false)
Includes pos, invoice, or return object inside each payment object, if true.

PRODUCTS

WarrantyCollection DELETE PATCH PUT POST GET /warranties

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Name,Term days,Description,Created date,Status
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy

Member DELETE PATCH PUT POST GET /products/{productId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
delete
put
optional string name
Product name. Maximum length is 100 characters.
optional string type (default: product)
Valid product types are: product,service
optional string condition
[runtime expression]
optional string code
Product code. Maximum length is 25 characters.
optional string boughtFrom
Valid {customer_id}. Get valid list of customers via customers/customers endpoint
optional string imei
Product imei. Maximum length is 20 characters.
optional string category
Valid {categoryId}.Get valid list of categories via /categories endpoint
optional string model
Valid {modelId}. Get valid list of models via /models endpoint
optional string status
Active,In active,Request
optional boolean oneTimeUse
Valid options are: True/False, Yes/No, 1/0
optional boolean inventoryControl
Valid options are: True/False, Yes/No, 1/0
optional boolean TaxIncludedInCost
Valid options are: True/False, Yes/No, 1/0. This option is ignored when {tax} has a VAT Margin Scheme
optional numeric cost
Product cost. The cost will be assumed as exclusive of tax when {tax} has a VAT Margin Scheme
optional boolean TaxIncludedInPrice
Valid options are: True/False, Yes/No, 1/0. This option is ignored when {tax} has a VAT Margin Scheme
optional numeric price
Product price. The price will be assumed as exclusive of tax when {tax} has a VAT Margin Scheme
optional boolean enableOfferPrice (default: false)
Valid options are: True/False, Yes/No, 1/0
optional string offerStart
Provide date in 'dd-mmm-yyyy hh:mm' format
optional string offerEnd
Provide date in 'dd-mmm-yyyy hh:mm' format
optional boolean TaxIncludedInOfferPrice
Valid options are: True/False, Yes/No, 1/0
optional numeric offerPrice
Product offer price
optional numeric tax
Valid {taxId}. Get valid list of taxes via shop/taxRateCollection endpoint
optional string alertQuantity
Product alert quantity
optional boolean discountable
Valid options are: True/False, Yes/No, 1/0
optional string supplier
Valid {supplierId}. Get valid list of suppliers via supplier/supplierCollection endpoint
optional numeric reorderQuantity
Product reorder quantity
optional string supplierItemCode
Supplier item code
optional boolean emailToSupplier
Valid options are: True/False, Yes/No, 1/0
optional string physicalLocation
Product physical location
optional string warranty
Valid {warrantyId}. Get valid list of warranties via /warranties endpoint
optional boolean serialisedStock
Valid options are: True/False, Yes/No, 1/0
optional boolean maintenancePlan
Valid options are: True/False, Yes/No, 1/0
optional numeric planDuration (default: 3)
Valid options are: 3,6,9,12,15,18,21,24,27,30,33,36
optional numeric serviceSchedule (default: 1)
Valid options are: 1,2,3,4,5,6,7,8,9,10,11,12
optional string description
Product description
optional numeric stockQuantity
Product stock quantity if you want to add stock (Must be greater than 0)

Collection DELETE PATCH PUT POST GET /products

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
Possible options: newest, oldest, recently_updated
optional searchKeyword (default: "")
Search in Product Name,Code,Model,Brand,Category,Condition,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional updatedDateFrom (default: "")
dd-mmm-yyyy
optional updatedDateTo (default: "")
dd-mmm-yyyy
optional type (default: "")
product,service
optional condition (default: "")
New,Used
optional code (default: "")
Product Code
optional category (default: "")
Product Category
optional model (default: "")
Product Model
optional status (default: "")
Active,In active
optional boolean includeCustomFields (default: false)
When true, custom fields object will be included if product has data for at least one custom field.
post
required string type (default: product)
Valid product types are: product,service
required string name
Product name. Maximum length is 100 characters.
required string condition (default: New)
[runtime expression]
required string code
Product code. Maximum length is 25 characters.
optional string boughtFrom
Valid {customer_id}. Get valid list of customers via customers/customers endpoint
optional string imei
Product imei. Maximum length is 20 characters.
optional string category
Valid {categoryId}.Get valid list of categories via /categories endpoint
optional string model
Valid {modelId}. Get valid list of models via /models endpoint
required string status
Active,In active,Request
optional boolean oneTimeUse
Valid options are: True/False, Yes/No, 1/0
optional boolean inventoryControl
Valid options are: True/False, Yes/No, 1/0
optional boolean TaxIncludedInCost
Valid options are: True/False, Yes/No, 1/0. This option is ignored when {tax} has a VAT Margin Scheme
required numeric cost
Product cost. The cost will be assumed as exclusive of tax when {tax} has a VAT Margin Scheme
optional boolean TaxIncludedInPrice
Valid options are: True/False, Yes/No, 1/0. This option is ignored when {tax} has a VAT Margin Scheme
required numeric price
Product price. The price will be assumed as exclusive of tax when {tax} has a VAT Margin Scheme
optional boolean enableOfferPrice (default: false)
Valid options are: True/False, Yes/No, 1/0
optional string offerStart
Provide date in 'dd-mmm-yyyy hh:mm' format
optional string offerEnd
Provide date in 'dd-mmm-yyyy hh:mm' format
optional boolean TaxIncludedInOfferPrice
Valid options are: True/False, Yes/No, 1/0
optional numeric offerPrice
Product offer price
required numeric tax
Valid {taxId}. Get valid list of taxes via shop/taxRateCollection endpoint
optional string alertQuantity
Product alert quantity
optional boolean discountable
Valid options are: True/False, Yes/No, 1/0
optional string supplier
Valid {supplierId}. Get valid list of suppliers via supplier/supplierCollection endpoint
optional numeric reorderQuantity
Product reorder quantity
optional string supplierItemCode
Supplier item code
optional boolean emailToSupplier
Valid options are: True/False, Yes/No, 1/0
optional string physicalLocation
Product physical location
optional string warranty
Valid {warrantyId}. Get valid list of warranties via /warranties endpoint
optional boolean serialisedStock
Valid options are: True/False, Yes/No, 1/0
optional boolean maintenancePlan
Valid options are: True/False, Yes/No, 1/0
optional numeric planDuration (default: 3)
Valid options are: 3,6,9,12,15,18,21,24,27,30,33,36
optional numeric serviceSchedule (default: 1)
Valid options are: 1,2,3,4,5,6,7,8,9,10,11,12
optional string description
Product description
optional numeric stockQuantity
Product stock quantity if you want to add stock (Must be greater than 0)

ModelCollection DELETE PATCH PUT POST GET /models

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Make,Model,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy

CategoryCollection DELETE PATCH PUT POST GET /categories

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Category,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy

BrandCollection DELETE PATCH PUT POST GET /brands

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Brand,Created Date
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy

SUPPLIERS

Member DELETE PATCH PUT POST GET /suppliers/{supplierId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

Collection DELETE PATCH PUT POST GET /suppliers

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Company,Contact name,Mobile,Phone,Date_Created
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional company (default: "")
Supplier Company
optional contactname (default: "")
Supplier Contact Name
optional mobile (default: "")
Supplier Mobile
optional phone (default: "")
Supplier Telephone
optional email (default: "")
Supplier Email Address
optional address (default: "")
Supplier Address
optional town (default: "")
Suuplier Town
optional county (default: "")
Suuplier County
optional postcode (default: "")
Suuplier Postcode
optional countrycode (default: "")
Suuplier CountryCode
optional status (default: "")
Active,In active

PURCHASEORDERS

Member DELETE PATCH PUT POST GET /purchaseOrders/{purchaseOrderId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

Collection DELETE PATCH PUT POST GET /purchaseOrders

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Number,Status,Date_Created,Received Date,Cost,Shipping Cost
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional number (default: "")
Reference Number
optional status (default: "")
Received,Pending,Ordered,Waiting Confirmation,Partially Delivered
optional boolean includeLines (default: false)
Item lines will be included if set to true.

LEADS

Member DELETE PATCH PUT POST GET /leads/{leadId}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
delete

Collection DELETE PATCH PUT POST GET /leads

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Detail, Company, Mobile, Telephone, Address
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (default: "")
dd-mmm-yyyy
optional ticket (default: "")
Ticket Short Info
optional customer (default: "")
Customer Name, Company
optional issue (default: "")
Issue Subject
optional issueDescription (default: "")
Issue Description
optional issuetype (default: "")
Issue Type ID
optional status (default: "")
New,Lead,First Contact,Opportunity,Prospect,Waiting on Customer,In Negotiation,Pending,Won,Lost

CUSTOMFIELDS

Collection DELETE PATCH PUT POST GET /customFields/{type:tickets|customers|products}

URI Tokens: (required)

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional categoryId (default: 0)
Custom Fields Category for type {tickets}. By default only default custom fields are returned.
optional tabId (default: 0)
Custom Fields Tab for type {tickets}. By default only default custom fields are returned.

MISC

Shipments DELETE PATCH PUT POST GET /shipments

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
Possible options: newest, oldest, recently_updated
optional string ticketId
Retrieve shipments related to this ticket. {id} in /tickets endpoint.
optional string customerId
Retrieve shipments related to this customer. {id} in /customers endpoint.
optional string pin
Shipment or Return Shipment tracking number.

REPORTS

MonthlySales DELETE PATCH PUT POST GET /monthlySales

Request Body:

Loading...

Response:

get
optional string year
Year in format 'yyyy'

MonthlyPurchase DELETE PATCH PUT POST GET /monthlyPurchases

Request Body:

Loading...

Response:

get
optional numeric year
Year in format 'yyyy'

DailySales DELETE PATCH PUT POST GET /dailySales

Request Body:

Loading...

Response:

get
optional string dateFrom
Date in format 'dd-mmm-yyyy'
optional string dateTo
Date in format 'dd-mmm-yyyy'

DailyPurchases DELETE PATCH PUT POST GET /dailyPurchases

Request Body:

Loading...

Response:

get
optional string dateFrom
Date in format 'dd-mmm-yyyy'
optional string dateTo
Date in format 'dd-mmm-yyyy'

WEBHOOK

InboundCall DELETE PATCH PUT POST GET /webhook/inbound-call/{inboundNumber}

URI Tokens: (required)

Request Body:

Loading...

Response:

get

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.