MGR API EXPLORER

Resources/Endpoints:

SHOP

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

shopUserCollection 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

shopTaxRateCollection DELETE PATCH PUT POST GET /taxRates

Request Body:

Loading...

Response:

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

shopPaymentMethodCollection 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

shopInfo DELETE PATCH PUT POST GET /info

Request Body:

Loading...

Response:

get

CUSTOMERS

customersMember 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

customersCollection 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
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

TICKETS

ticketsMemberUploadDoc 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)

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

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

ticketsCollection DELETE PATCH PUT POST GET /tickets

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
optional searchKeyword (default: "")
Search in Short Info, Comments
optional createdDateFrom (default: "")
dd-mmm-yyyy
optional createdDateTo (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.
post
required string customerId
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 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
      }
   ]
}

ticketsStatusCollection 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

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

ticketsPresetsCollection 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 make (default: "")
Product Make ID
optional model (default: "")
Product Model ID
optional issuetype (default: "")
Issue Type ID
optional legaldocument (default: "")
Legal Document ID

ticketsIssueTypeCollection 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

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

invoicesTicketCollection 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 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'

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

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

invoicesPaymentsCollection 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

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

productsCollection DELETE PATCH PUT POST GET /products

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)
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 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

productsModelCollection 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

productsBrandCollection DELETE PATCH PUT POST GET /brands

Request Body:

Loading...

Response:

get
optional page (default: 1)
optional sort (default: newest)

SUPPLIERS

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

suppliersCollection 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 status (default: "")
Active,In active

PURCHASEORDERS

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get

purchaseOrdersCollection 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

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

URI Tokens: (required)

Request Body:

Loading...

Response:

get
delete

leadsCollection 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

customFieldsCollection 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.

WEBHOOK

webhookInboundCall 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.