SFM

APIDescription
POST api/SFM/ImportClient?companyKey={companyKey}

Creates a client

POST api/SFM/UpdateClient?companyKey={companyKey}

Updates a client

Loyalty

APIDescription
POST api/Loyalty/CreateCustomer?companyKey={companyKey}

Creates a customer with the specified parameters.

POST api/Loyalty/UpdateCustomer?companyKey={companyKey}

Updates an existing customer with the specified parameters.

GET api/Loyalty/GetCustomerByCode?code={code}&companyKey={companyKey}

Retrieves a Loyalty customer by code.

GET api/Loyalty/GetCustomers?customerCodes[0]={customerCodes[0]}&customerCodes[1]={customerCodes[1]}&companyKey={companyKey}

Retrieves a list of Loyalty customers by codes. If no customer codes are provided, all customers will be returned

GET api/Loyalty/GetAnalyses?companyKey={companyKey}

Gets the list of available and active analyses.

GET api/Loyalty/GetCompanyRates?companyKey={companyKey}

Gets the list company point rates.

GET api/Loyalty/GetCustomerGroupRates?companyKey={companyKey}

Gets the list point rates per customer group.

GET api/Loyalty/GetCustomerRate?customerCode={customerCode}&companyKey={companyKey}

Gets the specified customer's point rates.

POST api/Loyalty/CreatePointsTransaction?companyKey={companyKey}

Creates a points transaction with the specified details.

GET api/Loyalty/GetCustomerTransactionsByDate?customerCode={customerCode}&dateFrom={dateFrom}&dateTo={dateTo}&companyKey={companyKey}

Returns a list of point transactions for the specified customer and date range (maximum range of 33 days).

GET api/Loyalty/GetCustomerTransactionsBySysref?sysrefNumberFrom={sysrefNumberFrom}&companyKey={companyKey}

Returns a maximum of 100 customer point transactions starting from the specified system reference number. To get all the following transactions, this method must be called again until no transactions are received.

GET api/Loyalty/GetCustomerPointBalances?companyKey={companyKey}

Returns the point balances of all customers.

GET api/Loyalty/GetTempLog?isDownload={isDownload}&fileName={fileName}

No documentation available.

SIMS

APIDescription
GET api/SIMS/GetStockQuantity?stockCode={stockCode}&companyKey={companyKey}

Gets the quantity of the stock code specified.

GET api/SIMS/GetStockLocationInfo?stockCodes[0]={stockCodes[0]}&stockCodes[1]={stockCodes[1]}&companyKey={companyKey}

Gets the quantity per location of the stock code(s) specified. If no stock codes are specified, the quantities per location of all stock cards are returned.

GET api/SIMS/GetStockCodes?companyKey={companyKey}

Gets the codes of all the Stock Cards.

GET api/SIMS/GetStockImages?stockCodes[0]={stockCodes[0]}&stockCodes[1]={stockCodes[1]}&companyKey={companyKey}

Gets the image of the stock code(s) specified. If no stock codes are specified, the linked images of all stock cards are returned.

GET api/SIMS/GetStockDetail?stockCodes[0]={stockCodes[0]}&stockCodes[1]={stockCodes[1]}&companyKey={companyKey}

Gets the stock card details for the stock code(s) specified. If no stock codes are specified, the details of all stock cards are returned.

GET api/SIMS/GetStockCategories?categoryCodes[0]={categoryCodes[0]}&categoryCodes[1]={categoryCodes[1]}&companyKey={companyKey}

Gets the stock category details for the category code(s) specified. If no category codes are specified, the details of all stock categories are returned.

GET api/SIMS/GetStockDetailByStyle?style={style}&companyKey={companyKey}

Gets the stock card details specified by style.

GET api/SIMS/GetStockDetailByBarcode?barcode={barcode}&companyKey={companyKey}

Gets the stock card details specified by barcode.

GET api/SIMS/GetStockBarcodes?stockCode={stockCode}&companyKey={companyKey}

Gets all the available barcoes for the specified Stock Card.

GET api/SIMS/GetStockDetailByReplicationId?replicationId={replicationId}&companyKey={companyKey}

Gets the details of stock cards by replication ID

GET api/SIMS/GetAllContractedPrices?replicationId={replicationId}&companyKey={companyKey}

Gets all Contracted Prices details

GET api/SIMS/GetAllContractedPricesByClient?client={client}&replicationId={replicationId}&companyKey={companyKey}

Gets Contracted Prices details by client

GET api/SIMS/GetPricesByClientStkCodeDate?client={client}&stockCode={stockCode}&Date={Date}&companyKey={companyKey}

Gets Contracted Prices details by client, stock code and date

GET api/SIMS/GetClientTransactionHistory?clientCodes[0]={clientCodes[0]}&clientCodes[1]={clientCodes[1]}&companyKey={companyKey}

Gets the transaction history for the specified client(s) from the linked SFM company

GET api/SIMS/GetClientOutstandingInvoices?clientCodes[0]={clientCodes[0]}&clientCodes[1]={clientCodes[1]}&companyKey={companyKey}

Gets the outstanding invoice(s) for the specified client(s) from the linked SFM company

GET api/SIMS/GetTransactionDetails?sysrefs[0]={sysrefs[0]}&sysrefs[1]={sysrefs[1]}&companyKey={companyKey}

Gets the transaction text details for the specified transaction system reference(s)

GET api/SIMS/GetClientDetails?clientCodes[0]={clientCodes[0]}&clientCodes[1]={clientCodes[1]}&companyKey={companyKey}

Gets the client details for the specified client(s). If no client code(s) are specified, the details of all clients are returned.

GET api/SIMS/GetLatestReplicId?companyKey={companyKey}

Gets the latest replic ID from the database

POST api/SIMS/ImportSalesOrder?companyKey={companyKey}

Posts a sales order, with no items being deducted from SIMS until the sales order is processed into a sale.

POST api/SIMS/ImportTransactions?companyKey={companyKey}

Posts sales transactions into SIMS gateway, single line or multi-line transactions can be specified

GET api/SIMS/GetSalesOrderState?Ref={Ref}&companyKey={companyKey}

Get the status of the sales order

GET api/SIMS/GetWebCategoryInfo?companyKey={companyKey}

Gets all the records in the web category table in the database

GET api/SIMS/GetStockExtWeb?companyKey={companyKey}

Gets all the records in the stock ext web table in the database

GET api/SIMS/GetStockWebCat?companyKey={companyKey}

Gets all the records in the stock web category table in the database

GET api/SIMS/GetClientTransactionHistoryByTranTypeAndRef?tranType={tranType}&tranRef={tranRef}&companyKey={companyKey}

Gets the client transaction history according to the transaction type and reference

GET api/SIMS/GetResourcesByReplicIds?replicIds[0]={replicIds[0]}&replicIds[1]={replicIds[1]}&companyKey={companyKey}

Gets all the resources and images in the database according to the list of ReplicIds given by the user

GET api/SIMS/GetResourcesByReplicIdsAndFileExtensions?startReplicId={startReplicId}&endReplicId={endReplicId}&fileExtensions[0]={fileExtensions[0]}&fileExtensions[1]={fileExtensions[1]}&companyKey={companyKey}

Gets a list of resources in the database according to a range of ReplicIds and file extensions. The resources retrieved will have their ReplicId between the ones specified, including both the start and end IDs. The file extensions is optional and if left empty will retrieve all of the items regardless of extension.

GET api/SIMS/GetResourcesByStockCodes?stockCodes[0]={stockCodes[0]}&stockCodes[1]={stockCodes[1]}&companyKey={companyKey}

Gets all the resources in the database according to the list of Stock Codes given by the user

GET api/SIMS/GetClientAddresses?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}&companyKey={companyKey}

Gets a list of client addresses. If no client IDs are provided, all the client addresses will be returned.

GET api/SIMS/GetStockCodesByReplicationId?replicationId={replicationId}&companyKey={companyKey}

Gets a list of stock codes according to the replic ID.

GET api/SIMS/GetStockBatchesExpiry?stockCodes[0]={stockCodes[0]}&stockCodes[1]={stockCodes[1]}&companyKey={companyKey}

Gets the list of stock details along with their batch details and expiry dates

POST api/SIMS/TransferLocation?companyKey={companyKey}

Transfers stock from one location to another.

POST api/SIMS/ImportSellingPrices?companyKey={companyKey}

Imports selling prices of a specific stock code

GET api/SIMS/GetDepartments?departmentCodes[0]={departmentCodes[0]}&departmentCodes[1]={departmentCodes[1]}&companyKey={companyKey}

Gets all the department details

GET api/SIMS/GetTotalStockDetailByReplicationId?replicationId={replicationId}&companyKey={companyKey}

Gets the total number of stock within one Replic ID

GET api/SIMS/GetStockDetailByReplicationIdPaginated?replicationId={replicationId}&page={page}&pageSize={pageSize}&companyKey={companyKey}

Gets a list of stock items limited to a certain number according to the page number provided and the page size limitation provided

POST api/SIMS/ImportPurchases?companyKey={companyKey}

Imports a list of purchases