API
| ID | Description | API |
|---|---|---|
|
API-001 |
Get api key detail of the logged in user |
GET api/key |
|
API-003 |
Get user role of the logged in user |
GET api/role |
|
API-004 |
Get api access right of the logged in user |
GET api/access?accessType={accessType} |
|
API-005 |
Get user details of the logged in api user |
GET api/user |
|
API-006 |
Get web store |
GET api/webstore?webSiteCode={webSiteCode} |
|
API-007 |
Get api web store image |
GET api/webstore/image?webSiteCode={webSiteCode}&entityCode={entityCode}&entityType={entityType} |
ChangeLog
Change log related transactions endpoints
| ID | Description | API |
|---|---|---|
|
LOG-001 |
Get change log by resource and date range |
GET changelog/{resource}?from={from}&to={to}&enableSessionDelete={enableSessionDelete} |
|
LOG-002 |
Delete change log by resource and date range |
DELETE changelog/{resource}?from={from}&to={to} |
|
LOG-003 |
Delete change log by Id range |
DELETE changelog/id?resource={resource}&from={from}&to={to} |
|
LOG-004 |
Delete change log before a given date. |
DELETE changelog?dateTo={dateTo} |
|
LOG-005 |
Delete change log by session id created when you enabledeletsesion upon requesting change log |
DELETE changelog?sessionId={sessionId} |
ClassTemplate
Class Template related transaction endpoints
| ID | Description | API |
|---|---|---|
|
CLS-001 |
Get customer class template |
GET classtemplate/customer/{classCode} |
|
CLS-002 |
Get customer ship to class template |
GET classtemplate/shipto/{classCode} |
CRM
| ID | Description | API |
|---|---|---|
|
CRM-001 |
Get CRM Activity by activity code |
GET crm/activity?activityCode={activityCode} |
|
CRM-009 |
Get Activity List by Status/Type |
GET crm/activity?status={status}&type={type}&entityCode={entityCode} |
|
CRM-002 |
Get CRM Leads |
GET crm/lead?leadCode={leadCode} |
|
CRM-003 |
Get CRM Contact |
GET crm/contact?contactCode={contactCode} |
|
CRM-004 |
By Customer Code, POST New Case |
POST crm/case |
|
CRM-005 |
Create a Leads |
POST crm/leads |
|
CRM-006 |
Get list of Opportunity by Customer |
GET crm/opportunity?customerCode={customerCode} |
|
CRM-007 |
Get list of Opportunity by Contact |
GET crm/opportunity?contactCode={contactCode} |
|
CRM-008 |
Get list of Opportunity by Stage |
GET crm/opportunity?stage={stage}&entityCode={entityCode} |
|
CRM-010 |
Get CRM Activity(Case, To-Do, Meeting, Call and Callback) by subject |
GET crm/activity?subject={subject} |
|
CRM-011 |
Get CRM Activity(Case, To-Do, Meeting, Call and Callback) by date range (creation date) |
GET crm/activity?dateFrom={dateFrom}&dateTo={dateTo} |
|
CRM-017 |
Get CRM Activity by date range (creation date), status and type. |
GET crm/activity?dateFrom={dateFrom}&dateTo={dateTo}&type={type}&status={status} |
|
CRM-012 |
Get CRM Notes by title |
GET crm/note?title={title} |
|
CRM-013 |
Get CRM Notes by date range (creation date) |
GET crm/note?dateFrom={dateFrom}&dateTo={dateTo} |
|
CRM-014 |
Get CRM Opportunity |
GET crm/opportunity?opportunityName={opportunityName} |
|
CRM-015 |
Get CRM Opportunity by date range (creation date) |
GET crm/opportunity?dateFrom={dateFrom}&dateTo={dateTo} |
|
CRM-016 |
Create Opportunities |
POST crm/opportunity |
|
CRM-018 |
Update a Case |
PUT crm/case |
|
CRM-019 |
Search CRM contact or customer via phone number or mobile number |
GET crm/contact?phoneNumber={phoneNumber} |
|
CRM-020 |
Get outstanding case list by customer code or comma separated customer codes |
GET crm/b2b/case?customerCode={customerCode} |
|
CRM-021 |
Get historical case list by customer code or comma separated customer codes |
GET crm/b2b/case/history?customerCode={customerCode} |
|
CRM-022 |
Get CRM case detail by case code or comma separated case codes |
GET crm/b2b/case/detail?caseCode={caseCode} |
|
CRM-023 |
By Ship To Code, POST New Customer Ship To Note |
POST crm/shipto/note |
|
CRM-024 |
By Note Code, Update Customer Ship To Note |
PUT crm/shipto/note |
|
CRM-025 |
Get CRM Notes by ShipToCode |
GET crm/shipto/note?shipToCode={shipToCode}¬eCode={noteCode} |
|
CRM-026 |
By Ship To Code, POST New Customer Ship To Contact |
POST crm/shipto/contact |
|
CRM-027 |
By Contact Code or Contact Full Name and Ship To Code, Update Customer Ship To Contact |
PUT crm/shipto/contact |
|
CRM-028 |
Get Customer Ship To Contact by ShipToCode |
GET crm/shipto/contact?shipToCode={shipToCode}&contactCode={contactCode} |
|
CRM-029 |
Get Contacts by date range (creation date) |
GET crm/contact?dateFrom={dateFrom}&dateTo={dateTo} |
|
CRM-030 |
Get CRM Notes by NoteCode |
GET crm?noteCode={noteCode} |
Customer
| ID | Description | API |
|---|---|---|
|
CUS-001 |
POST New Customer or Prospect |
POST customer |
|
CUS-002 |
Update customer details |
PUT customer |
|
CUS-003 |
By Customer Code, POST New Contact |
PUT customer/AddContact |
|
CUS-004 |
Add ShipTo to existing customer with function to set DefaultShipToCode |
PUT customer/AddShipTo |
|
CUS-005 |
Update existing customer contacts |
PUT customer/UpdateContact |
|
CUS-006 |
Get Customer by CustomerCode |
GET customer?customerCode={customerCode} |
|
CUS-007 |
Get Customer Special Price by CustomerCode and ItemCode |
GET customer/specialprice?customerCode={customerCode}&date={date}&itemCode={itemCode} |
|
CUS-008 |
Get Customer Ship Tos by CustomerCode |
GET customer/shipto?customerCode={customerCode} |
|
CUS-009 |
Get Customer Contacts by CustomerCode |
GET customer/Contact?customerCode={customerCode} |
|
CUS-010 |
Get Customer Credits Detail by CustomerCode |
GET customer/CreditDetail?customerCode={customerCode} |
|
CUS-011 |
Get customer trading information like balances, sales orders and credit limit |
GET customer/tradinginfo?customerCode={customerCode} |
|
CUS-012 |
Get Customer Invoices by CustomerCode |
GET customer/invoice?customerCode={customerCode} |
|
CUS-013 |
Get Customer Sales Orders by CustomerCode |
GET customer/salesorder?customerCode={customerCode} |
|
CUS-014 |
Get Customer Statement of Account |
GET customer/statementofaccount |
|
CUS-015 |
Get Customer Statement of Account per customer |
GET customer/statementofaccount?customerCode={customerCode} |
|
CUS-016 |
Get customer data(Customer code, Contact code and API Customer Id) with specified email address |
GET customer?emailAddress={emailAddress}&isShowAll={isShowAll} |
|
CUS-017 |
Get customer codes |
GET customer/code?onlyActive={onlyActive}&dateFrom={dateFrom}&dateTo={dateTo} |
|
CUS-018 |
Get Customer data |
GET customer?onlyActive={onlyActive} |
|
CUS-019 |
Get Customer prospects data |
GET customer/prospect?onlyActive={onlyActive} |
|
CUS-020 |
By Customer Code, POST New Receipt |
POST customer/receipt |
|
CUS-021 |
Allocate customer receipt |
POST customer/receipt/allocation |
|
CUS-022 |
Confirms a sales order and creates an invoice |
POST customer/confirmpick |
|
CUS-023 |
Get customer activity by Customer code |
GET customer/activity?customerCode={customerCode} |
|
CUS-025 |
Get Customer Notes by Customer code |
GET customer/note?customerCode={customerCode} |
|
CUS-026 |
Get Customer by Customer name |
GET customer?customerName={customerName} |
|
CUS-027 |
Get Customer by date range (creation date) |
GET customer?dateFrom={dateFrom}&dateTo={dateTo} |
|
CUS-028 |
Get Customer Contacts by Customer Name |
GET customer/contact?customerName={customerName} |
|
CUS-029 |
Get Customer contact by date range (creation date) |
GET customer/contact?dateFrom={dateFrom}&dateTo={dateTo} |
|
CUS-030 |
Get Customer Ship Tos by Customer name |
GET customer/shipto?customerName={customerName} |
|
CUS-031 |
Get Customer Ship Tos by date range (creation date) |
GET customer/shipto?dateFrom={dateFrom}&dateTo={dateTo} |
|
CUS-032 |
Get Customer Statement of Account by Reference number |
GET customer/statementofaccount?reference={reference} |
|
CUS-033 |
Get Customer Statement of Account by PO Code |
GET customer/statementofaccount?poCode={poCode} |
|
CUS-034 |
Get Customer Statement of Account by PO Code and Reference number |
GET customer/statementofaccount?poCode={poCode}&reference={reference} |
|
CUS-035 |
Get Customer Statement of Account by date range (invoice date) |
GET customer/statementofaccount?dateFrom={dateFrom}&dateTo={dateTo} |
|
CUS-036 |
Get Customer by Ship To Code |
GET customer?shipToCode={shipToCode} |
|
CUS-037 |
Update customer ship to details |
PUT customer/shipto |
|
CUS-038 |
Convert a prospect to customer |
POST customer/convertprospect |
|
CUS-039 |
Get Customer Items |
GET customer/items?customerCode={customerCode} |
|
CUS-040 |
Get Customer ship to address by customer code or comma separated customer codes |
GET customer/b2b/shipto?customerCode={customerCode} |
|
CUS-041 |
Get Customer address by customer code or comma separated customer codes |
GET customer/b2b/address?customerCode={customerCode} |
|
CUS-042 |
Get Customer net price by customer code and item name (single item name or comma separated item names) |
GET customer/b2b/netprice?customerCode={customerCode}&itemName={itemName} |
|
CUS-043 |
Get Customer net price by customer code, itemname, qty or uom |
GET customer/b2b/netprice?customerCode={customerCode}&itemName={itemName}&qty={qty}&uom={uom} |
|
CUS-044 |
Get Customer Statement of Account by customer code or comma separated customer codes |
GET customer/b2b/statement?customerCode={customerCode} |
|
CUS-045 |
Get Customer Statement of Account summary by customer code or comma separated customer codes |
GET customer/b2b/statementsummary?customerCode={customerCode} |
|
CUS-046 |
Get list of customers |
GET customer/basic/list |
|
CUS-047 |
By Customer Code, POST New Ship To |
POST customer/basic/shipto |
|
CUS-048 |
By Customer Code, POST New Customer Note |
POST customer/note |
|
CUS-049 |
By Note Code, Update Customer Note |
PUT customer/note |
|
CUS-050 |
Get Active Customer Name, Trading Info, Credit Hold etc by Customer Code, comma for multiple or All |
GET customer/trading?customerCode={customerCode} |
|
CUS-051 |
Allocate single or multiple customer receipt or credit memo |
POST customer/receipt/allocation/advanced |
|
CUS-052 |
Get customer data(Only Active : Customer code, Contact code and API Customer Id) with specified email address |
GET customer/active?emailAddress={emailAddress}&isShowAll={isShowAll} |
|
CUS-053 |
Get Customer Ship To by ShipToCode |
GET customer/shipto?shipToCode={shipToCode} |
|
CUS-054 |
Get All Customer Special Price |
GET customer/specialprice/all |
CustomerCredit
RMA/Credit Memo api endpoints
| ID | Description | API |
|---|---|---|
|
CCR-001 |
By Customer Code Create RMA (Like POST New Sales Order (Customer, Shipto, Item Lines,) |
POST customercredit/rma |
|
CCR-002 |
By RMA Code Update RMA |
PUT customercredit/rma |
|
CCR-003 |
By RMA Code Convert RMA to Credit |
POST customercredit/rma/convert |
|
CCR-004 |
By Customer Code Create Credit Note (Like POST New Sales Order (Customer, Shipto, Item Lines,) |
POST customercredit/creditnote |
CustomerInvoice
| ID | Description | API |
|---|---|---|
|
IVC-001 |
Creates customer invoice |
POST invoice |
|
IVC-002 |
Get Customer Invoice or Credit Memo by InvoiceCode/Credit Memo Code |
GET invoice/{invoiceCode} |
|
IVC-003 |
Get Customer Invoice or Credit Memo Detail by InvoiceCode/Credit Memo Code |
GET invoice/{invoiceCode}/detail |
|
IVC-004 |
Get Inventory Batch Serial by Invoice Code/Credit Memo Code |
GET invoice/{invoiceCode}/batchserial |
|
IVC-005 |
Get Inventory Batch Serial History by Invoice Code |
GET invoice/{invoiceCode}/batchserialhistory |
|
IVC-006 |
Get invoice details by PO Code |
GET invoice?poCode={poCode} |
|
IVC-007 |
Get invoice details by Reference number |
GET invoice?reference={reference} |
|
IVC-008 |
Get invoice details by PO Code and Reference number |
GET invoice?poCode={poCode}&reference={reference} |
|
IVC-009 |
No documentation available. |
GET invoice?dateFrom={dateFrom}&dateTo={dateTo}&activeCustomerOnly={activeCustomerOnly}&isVoided={isVoided} |
|
IVC-010 |
Get transaction list (invoice and credits) by customer code or comma separated customer codes |
GET invoice/b2b/transactionlist?customerCode={customerCode} |
|
IVC-011 |
Get invoice detail by invoice code |
GET invoice/b2b/detail?code={code} |
|
IVC-012 |
By Invoice Document Code(s), Tick Freight Box, Update Shipping Method and Notes |
PUT invoice/shippingmethod |
CustomerPricing
CustomerSalesOrder
| ID | Description | API |
|---|---|---|
|
ORD-001 |
Get Sales Order/ RMA / Quote / Back Order by salesOrderCode |
GET salesorder/{salesOrderCode} |
|
ORD-002 |
Get Sales Order/ RMA / Quote / Back Order Detail by salesOrderCode |
GET salesorder/{salesOrderCode}/detail |
|
ORD-003 |
By Customer Code, POST New Sales Order (Customer, Shipto, SO Item Lines, New Receipt) |
POST salesorder |
|
ORD-004 |
Get list of Sales Order/ RMA / Quote / Back Order by customer code |
GET salesorder?customerCode={customerCode} |
|
ORD-005 |
Get Inventory Batch Serial History by Sales Order Code |
GET salesorder/{salesOrderCode}/batchserialhistory |
|
ORD-006 |
Get customer sales order work flow |
GET salesorder/{salesOrderCode}/workflow |
|
ORD-007 |
Update Customer Sales Order data |
PUT salesorder |
|
ORD-008 |
Get customer sales order for picking |
GET salesorder/pick?routeCode={routeCode}&allocationStatus={allocationStatus}&warehouse={warehouse} |
|
ORD-009 |
Get allocation for all items in sales order |
GET salesorder/allocation?salesOrderCode={salesOrderCode} |
|
ORD-010 |
Get allocation for an item in sales order |
GET salesorder/allocation?salesOrderCode={salesOrderCode}&itemCode={itemCode} |
|
ORD-011 |
Get sales order status and the total quantity |
GET salesorder/status?salesOrderCode={salesOrderCode} |
|
ORD-012 |
Get Sales Order/ RMA / Quote / Back Order Detail using a specified column and value |
GET salesorder?column={column}&value={value} |
|
ORD-013 |
Get sales order details which includes item details, unit of measure, batch serial and ship to |
GET salesorder?salesOrderCode={salesOrderCode}&itemCode={itemCode} |
|
ORD-014 |
Get sales order details by PO Code |
GET salesorder?poCode={poCode} |
|
ORD-015 |
Get sales order details by Reference number |
GET salesorder?reference={reference} |
|
ORD-016 |
Get sales order details by PO Code and Reference number |
GET salesorder?poCode={poCode}&reference={reference} |
|
ORD-017 |
Get Customer Sales order by date range (creation date) |
GET salesorder?dateFrom={dateFrom}&dateTo={dateTo}&activeCustomerOnly={activeCustomerOnly}&isVoided={isVoided} |
|
ORD-018 |
Convert quote to sales order |
POST salesorder/convertquote |
|
ORD-019 |
By Customer Code, POST New Receipt |
PUT salesorder/receipt |
|
ORD-020 |
Attach a document/file to Sales Order/ RMA / Quote / Back Order. |
POST salesorder/attachment?salesOrderCode={salesOrderCode}&fileName={fileName} |
|
ORD-021 |
Get Sales Order/ RMA / Quote / Back Order attachment by salesOrderCode and optional attachment document code |
GET salesorder/attachment?salesOrderCode={salesOrderCode}&documentCode={documentCode} |
|
ORD-022 |
Delete order attachment by document code |
DELETE salesorder/attachment?documentCode={documentCode} |
|
ORD-023 |
Void a customer sales order. Allowed stages to be voided are Approve Credit, Print Picking Note and Ready to invoice. |
PUT salesorder/void?salesOrderCode={salesOrderCode} |
|
ORD-024 |
Update customer sales order ship to address |
PUT salesorder/shipto |
|
ORD-025 |
Get SO history item list by customer code or comma separated customer codes |
GET salesorder/b2b/sohistory?customerCode={customerCode} |
|
ORD-026 |
Get outstanding quote list by customer code or comma separated customer codes |
GET salesorder/b2b/quote?customerCode={customerCode} |
|
ORD-027 |
Get outstanding SO list by customer code or comma separated customer codes |
GET salesorder/b2b/order?customerCode={customerCode} |
|
ORD-028 |
Get historical sales order list by customer code or comma separated customer codes |
GET salesorder/b2b/order/history?customerCode={customerCode} |
|
ORD-029 |
Get outstanding RMA list by customer code or comma separated customer codes |
GET salesorder/b2b/rma?customerCode={customerCode} |
|
ORD-030 |
Get historical RMA list by customer code or comma separated customer codes |
GET salesorder/b2b/rma/history?customerCode={customerCode} |
|
ORD-031 |
Get order detail by order code |
GET salesorder/b2b/order/detail?code={code} |
|
ORD-032 |
Get quote detail by quote code |
GET salesorder/b2b/quote/detail?code={code} |
|
ORD-033 |
Get rma detail by rma code |
GET salesorder/b2b/rma/detail?code={code} |
|
ORD-034 |
Update Customer Sales Order detail |
PUT salesorder/detail |
|
ORD-035 |
By Customer Code or Email address POST Sales Order with Additional Logic: (If the Customer Entity Email address or Code does not exist create the Customer record. If the ship to Postcode does not exist for the linked Customer then create a Ship to, if it does then use it. If a Contact Email does not exist for the linked Customer then create Contact record, if it does use it. Optional: If the ItemName does not exist use Non Stock item with the order description or error.) |
POST salesorder/advance |
|
ORD-036 |
Void customer quote |
PUT salesorder/void/quote?documentCode={documentCode} |
|
ORD-037 |
Get Customer Sales Orders by Overall Due Date (Cancel Date) From and To, option to specify Shipping Method |
GET salesorder?dateFrom={dateFrom}&dateTo={dateTo}&shippingMethodCode={shippingMethodCode} |
Inventory
| ID | Description | API |
|---|---|---|
|
INV-001 |
POST New Stock Item (not Kit or Assembly) |
POST inventory |
|
INV-002 |
Updates an inventory item. Supported item types are Stock, Non-Stock, Service, Electronic Download. |
PUT inventory |
|
INV-003 |
Creates a set of inventory items. Supported item types are Stock, Non-Stock, Service, Electronic Download. |
POST inventory/batch |
|
INV-037 |
Update batches of inventory item. Supported item types are Stock, Non-Stock, Service, Electronic Download. |
PUT inventory/batch |
|
INV-004 |
Creates an inventory item Assembly. |
POST inventory/assembly |
|
INV-005 |
Update an inventory item Assembly. |
PUT inventory/assembly |
|
INV-006 |
Updates inventory supplier |
PUT inventory/supplier |
|
INV-007 |
Updates inventory supplier pricing level |
PUT inventory/supplier/pricinglevel |
|
INV-008 |
Get all Items by ItemType filter |
GET inventory/ItemList/{itemType} |
|
INV-009 |
Get Stock Quantity |
GET inventory/{itemCode}/StockQuantity |
|
INV-010 |
Get Stock Quantity Kit by Item Kit Code |
GET inventory/{itemKitCode}/KitStockQuantity?currency={currency} |
|
INV-011 |
Get Inventory Item by item code |
GET inventory/{itemCode} |
|
INV-012 |
Get Inventory Items using comma separated Item Codes |
GET inventory/items?itemCodes={itemCodes} |
|
INV-013 |
Get Inventory Item by item name |
GET inventory?itemName={itemName} |
|
INV-014 |
Get Inventory Item code by item name |
GET inventory/simple?itemName={itemName} |
|
INV-015 |
Get Transaction History Ledger |
GET inventory/{itemCode}/TransactionHistoryLedger |
|
INV-016 |
Get Inventory Kit |
GET inventory/kit/{itemKitCode} |
|
INV-017 |
Get Inventory Kit Details |
GET inventory/kit/{itemKitCode}/detail |
|
INV-018 |
Get Inventory Kit Pricing Details |
GET inventory/kit/{itemKitCode}/pricing |
|
INV-019 |
Get Inventory Kit Detail Description |
GET inventory/kit/{itemKitCode}/description |
|
INV-020 |
Get Inventory Kit Option Groups |
GET inventory/kit/{itemKitCode}/group |
|
INV-021 |
Get Inventory Kit Option Group Description |
GET inventory/kit/{itemKitCode}/groupdescription |
|
INV-022 |
Get Inventory Batch Serial |
GET inventory/{itemCode}/batchserial |
|
INV-023 |
Get Inventory Batch Serial History |
GET inventory/{itemCode}/batchserialhistory |
|
INV-024 |
Get Inventory Matrix Group |
GET inventory/matrix/{itemCode} |
|
INV-025 |
Get Inventory Matrix Items |
GET inventory/matrix/{itemCode}/detail |
|
INV-026 |
Get Inventory Matrix Group from matrix item code |
GET inventory/matrix?matrixitemCode={matrixitemCode} |
|
INV-027 |
Get Inventory Supplier |
GET inventory/{itemCode}/supplier |
|
INV-028 |
Get Inventory Supplier Pricing Level |
GET inventory/{itemCode}/supplierpricinglevel |
|
INV-029 |
Get Inventory Unit Measure |
GET inventory/{itemCode}/unitofmeasure |
|
INV-030 |
Get Item Description |
GET inventory/{itemCode}/description |
|
INV-031 |
Get Inventory Category |
GET inventory/{itemCode}/category |
|
INV-032 |
Get Inventory Department |
GET inventory/{itemCode}/department |
|
INV-033 |
Get inventory item special or promotional pricing |
GET inventory/specialprice?itemCode={itemCode}¤cyCode={currencyCode} |
|
INV-034 |
Get Inventory Item by item description |
GET inventory?itemDescription={itemDescription} |
|
INV-035 |
Get Inventory Item by unit of measure upc code |
GET inventory?upcCode={upcCode} |
|
INV-036 |
Get Inventory Item by date range (creation date) |
GET inventory?dateFrom={dateFrom}&dateTo={dateTo} |
|
INV-038 |
Create inventory supplier and supplier pricing level |
POST inventory/supplier/pricinglevel |
|
INV-041 |
Get all inventory item data including description, unit of measure, category, stock quantity, special pricing, retail pricing and whole sale pricing. |
GET inventory/all?itemCode={itemCode}&includeBinary={includeBinary} |
|
INV-042 |
Get Inventory Accessory Item |
GET inventory/{itemCode}/accessory |
|
INV-043 |
Get Inventory Substitute Item |
GET inventory/{itemCode}/substitute |
|
INV-044 |
Get all Items filtered by website, publish status, item status , item type, web site and department |
GET inventory/ItemList?itemType={itemType}&publishStatus={publishStatus}&websiteCode={websiteCode}&itemStatus={itemStatus}&departmentCode={departmentCode} |
|
INV-045 |
Get Inventory item documents and attachments |
GET inventory/{itemCode}/document?includeData={includeData} |
|
INV-047 |
Get items filtered by a column and value. |
GET inventory/custom?field={field}&value={value} |
|
INV-048 |
Creates an inventory adjustment in or adjustment out. |
POST inventory/adjustment |
|
INV-049 |
GET Category All List |
GET inventory/basic/category |
|
INV-050 |
GET Department All List |
GET inventory/basic/department |
|
INV-051 |
GET Stock All List |
GET inventory/basic/stock/list |
|
INV-052 |
By Stock Item ItemName(s), Warehouse – GET In Stock Qty, Potential Stock Qty |
GET inventory/basic/stock/qty?warehouseCode={warehouseCode}&itemName={itemName} |
|
INV-053 |
By Stock Item ItemName(s) – GET Retail and Wholesale Sell Price |
GET inventory/basic/stock/pricing?itemName={itemName} |
|
INV-054 |
By Stock Item ItemName(s) – GET Details, Descriptions, Category, Department, In Stock Qty, Sell Price, Custom fields etc. Full Details. |
GET inventory/basic/stock/detail?itemName={itemName} |
|
INV-055 |
By Warehouse or All – GET All Items, In Stock Qty, On SO Qty, On PO Qty, Potential Stock Qty, Retail Sell Price, Wholesale Sell Price |
GET inventory/basic/stock/priceqty?warehouse={warehouse} |
|
INV-056 |
By Web Site Name or All – GET Item List” |
GET inventory/basic/stock/api/showonweb?websiteName={websiteName}&isShowOnly={isShowOnly} |
|
INV-057 |
By ItemName(s) or All – GET API Item Tab Information |
GET inventory/basic/stock/api/detail?itemName={itemName}&displayType={displayType} |
|
INV-058 |
By ItemName – PUT Item API Tab Information |
PUT inventory/basic/stock/api/detail |
|
INV-059 |
By Kit ItemName(s), Warehouse – GET Default Bundle Components – Trial Build Qty using Free Stock |
GET inventory/basic/kit/qty?itemKitName={itemKitName}&warehouseCode={warehouseCode} |
|
INV-060 |
By Assembly ItemName(s), Warehouse – GET Trial Build Qty using Free Stock" |
GET inventory/basic/assembly/qty?assemblyName={assemblyName}&warehouseCode={warehouseCode} |
|
INV-061 |
By ItemName – PUT Item Details, Descriptions, Category, Department, In Stock Qty, Sell Price, Custom fields etc. Full Details. |
PUT inventory/basic/stock/detail |
|
INV-062 |
By Web Site Name or ID – GET Web Categories, SubCategories and Items |
GET inventory/webcategory?value={value}&type={type} |
|
INV-063 |
By Web Site Name or ID – PUT Web Categories, SubCategories |
PUT inventory/webcategory |
|
INV-064 |
By Web Site Name or ID – PUT Web Category Items |
PUT inventory/webcategory/item |
|
INV-065 |
By Web Site Name or ID – GET Web Categories, Subcategories and Custom Fields |
GET inventory/webcategoryfilter?value={value}&type={type} |
|
INV-066 |
By Stock Item ItemName(s), Warehouse – GET Purchase Order with Qty free based on SO/BKO qty – PO Item Line Due Date |
GET inventory/basic/stock/po?warehouseCode={warehouseCode}&itemName={itemName} |
|
INV-067 |
Get all inventory item special or promotional pricing |
GET inventory/specialprice/all |
InventoryImport
| ID | Description | API |
|---|---|---|
|
IMP-001 |
Import assembly items |
POST import/assembly |
ProjectCosting
| ID | Description | API |
|---|---|---|
|
PRJ-001 |
Get project costing data by project name |
GET projectcosting/project?projectName={projectName} |
|
PRJ-002 |
Get project costing data by project number |
GET projectcosting/project?projectNumber={projectNumber} |
|
PRJ-003 |
Get all project costing employees |
GET projectcosting/employee/all |
|
PRJ-004 |
Get project costing employee by employee code |
GET projectcosting/employee?employeeCode={employeeCode} |
|
PRJ-005 |
Get project costing employees by full name |
GET projectcosting/employee?employeeName={employeeName} |
|
PRJ-006 |
Get all project costing cost heading |
GET projectcosting/costheading/all |
|
PRJ-007 |
Get project costing cost heading |
GET projectcosting/costheading?code={code} |
|
PRJ-008 |
Get all project costing time sheet expense |
GET projectcosting/timesheet/all |
|
PRJ-009 |
Get project costing time sheet expense |
GET projectcosting/timesheet?projectNumber={projectNumber} |
|
PRJ-010 |
Get project costing time sheet expense by employee's full name |
GET projectcosting/timesheet?employeeName={employeeName} |
|
PRJ-011 |
Create project costing time sheet expense |
POST projectcosting/timesheet |
ShippingMethod
| ID | Description | API |
|---|---|---|
|
SHP-001 |
Get Shipping Methods and Postcode Area/Regions by ShippingMethodCode |
GET shippingmethod/ShippingMethod?shippingMethodCode={shippingMethodCode}&freightChargeType={freightChargeType} |
|
SHP-002 |
Get Shipping Methods Details and Postcode Area/Regions by ShippingMethodCode |
GET shippingmethod/ShippingMethodDetail?shippingMethodCode={shippingMethodCode}&freightChargeType={freightChargeType} |
|
SHP-003 |
Get system shipping method group |
GET shippingmethod/shippingmethodgroup |
|
SHP-004 |
Get system shipping carrier |
GET shippingmethod/shippingcarrier |
|
SHP-005 |
Get delivery routes |
GET shippingmethod/deliveryroute |
|
SHP-006 |
GET Shipping Methods All List |
GET shippingmethod/basic/list |
|
SHP-007 |
Get Shipping Method detail by shipping method code |
GET shippingmethod/basic/detail?code={code} |
Supplier
Supplier related transactions endpoints
| ID | Description | API |
|---|---|---|
|
SUP-001 |
Get supplier purchase order detail by item code |
GET supplier/purchaseorder?itemCode={itemCode} |
|
SUP-002 |
Get Supplier data by supplier code |
GET supplier/{supplierCode} |
|
SUP-003 |
Gets the corresponding supplier code of specific supplier name |
GET supplier/simple?supplierName={supplierName} |
|
SUP-004 |
Create supplier |
POST supplier |
SupplierBill
Supplier Bill related transactions endpoints
| ID | Description | API |
|---|---|---|
|
SBL-001 |
Create a supplier expense bill |
POST supplierbill |
|
SBL-002 |
Get available supplier bills |
GET supplierbill |
|
SBL-003 |
Get supplier bill detail |
GET supplierbill/{billCode}/detail |
|
SBL-004 |
Get Supplier Bill by bill code |
GET supplierbill/{billCode} |
|
SBL-005 |
Create a supplier bill from grn |
POST supplierbill/grn |
SupplierGoodsReceived
Supplier Purchase Receipt related transactions endpoints
| ID | Description | API |
|---|---|---|
|
GRN-001 |
Create a supplier purchase receipt(GRN) |
POST goodsreceived |
|
GRN-002 |
Get a list of GRN codes by Document Date or Creation Date |
GET goodsreceived?dateType={dateType}&dateFrom={dateFrom}&dateTo={dateTo} |
|
GRN-003 |
Get supplier GRN header and detail by GRN Code |
GET goodsreceived/all?grnCode={grnCode} |
SupplierPurchaseOrder
Supplier Purchase order related transactions endpoints
| ID | Description | API |
|---|---|---|
|
PO-001 |
Create a supplier purchase order |
POST purchaseorder |
|
PO-002 |
Update a supplier purchase order |
PUT purchaseorder |
|
PO-003 |
Get supplier purchase order header and detail by PO Code |
GET purchaseorder/all?poCode={poCode} |
|
PO-004 |
Convert drop shipment from sales order |
POST purchaseorder/createdropship |
|
PO-005 |
Get outstanding purchase orders by supplier code |
GET purchaseorder?supplierCode={supplierCode} |
|
PO-006 |
GET a list of PO codes by Document Date or Creation Date |
GET purchaseorder?dateType={dateType}&dateFrom={dateFrom}&dateTo={dateTo} |
SystemManager
System Manager related transactions
| ID | Description | API |
|---|---|---|
|
SYS-001 |
Get system currencies and exchange rates. |
GET system/currency |
|
SYS-002 |
Get system currency and exchange rate |
GET system/currency?currencyCode={currencyCode} |
|
SYS-003 |
Get system countries |
GET system/country |
|
SYS-004 |
Get system country |
GET system/country?countryCode={countryCode} |
|
SYS-005 |
Get system payment term |
GET system/paymentterm |
|
SYS-006 |
Get system payment term group |
GET system/paymenttermgroup |
|
SYS-007 |
Creates a manufactuer |
POST system/manufacturer |
|
SYS-008 |
Get system category discount |
GET system/category/discount?categoryCode={categoryCode}&band={band} |
|
SYS-009 |
Gets the configured database name |
GET system/db |
|
SYS-010 |
Get system category and its parent category |
GET system/category/structure |
|
SYS-011 |
Get system categories |
GET system/category/all |
|
SYS-012 |
Get a single category |
GET system/category?categoryCode={categoryCode} |
|
SYS-013 |
Get category description |
GET system/category/description?categoryCode={categoryCode} |
|
SYS-016 |
Get system payment type |
GET system/paymenttype/all |
|
SYS-017 |
Get system payment type by payment type code |
GET system/paymenttype?paymentTypeCode={paymentTypeCode} |
|
SYS-018 |
Get system payment term with payment method |
GET system/paymentterm/simple |
Tax
Tax related transactions endpoints
| ID | Description | API |
|---|---|---|
|
TAX-001 |
Get system tax scheme |
GET tax/{taxCode} |
|
TAX-002 |
Get system tax scheme detail |
GET tax/{taxCode}/detail |
|
TAX-003 |
Get system tax component |
GET tax/component/{taxDetailCode} |
ZBespoke
Bespoke api endpoints
| ID | Description | API |
|---|---|---|
|
ZBE-001 |
Get Customer Label ID by Customer Code |
GET zbespoke/customerlabel?customerCode={customerCode} |
|
ZBE-002 |
Update the Customer Label ID by customer code |
PUT zbespoke/customerlabel |
|
ZBE-003 |
Get by Customer Code(s) - Rebates Available |
GET zbespoke/rebates/customer?customerCode={customerCode} |
|
ZBE-004 |
Get by Customer Code + ItemName(s) – Rebates Available |
GET zbespoke/rebates/customer?customerCode={customerCode}&itemName={itemName} |
|
ZBE-005 |
By Stock Item ItemName(s) – GET Stock Level View |
GET zbespoke/stocklevelview?itemName={itemName} |