A Appendix: API URLs

This appendix provides an overview of the API URLs provided by the solution, along with their parameters and return types. For complete details on these APIs, refer to the Mobile Point-of-Service Javadoc.

About API

The following table describes the About APIs:

URL	HTTP Method	Parameters	Return Type
mobilepos/services/about/1.0/version
getVersion	GET	None	VersionStatus

Auth API

The following table describes the Auth API:

URL	HTTP Method	Parameters			Return Type
		Name	Data Type	Kind
mobilepos/services/auth/1.0/login
Login	POST	hardwareID locale	xs:string xs:string	FormParam FormParam	AuthStatusWithProfile
mobilepos/services/auth/1.0/login/{storeID}/{registerID}
Login	GET	registerID storeID locale	xs:string xs:string xs:string	PathParam PathParam QueryParam	AuthStatus
mobilepos/services/auth/1.0/logout/{storeID}/{registerID}
Logout	GET	registerID storeID	xs:string xs:string	PathParam PathParam	AuthStatus
mobilepos/services/auth/1.0/override/{storeID}/{registerID}
Override	POST	registerID storeID userID password	xs:string xs:string xs:string xs:string	PathParam PathParam FormParam FormParam	AuthStatus

Customer API

The following table describes the Customer API:

URL	HTTP Method	Parameters			Return Type
		Name	Data Type	Kind
mobilepos/services/customer/1.0/{storeID}/{registerID}/customersearch
searchCustomers	POST	registerID storeID firstName lastName businessName phoneNumber customerID	xs:string xs:string xs:string xs:string xs:string xs:string xs:string	PathParam PathParam FormParam FormParam FormParam FormParam FormParam	CustomerStatus
mobilepos/services/customer/1.0/{storeID}/{registerID}/customeradd
addCustomer	POST	registerID storeID firstName lastName businessName phoneNumber phoneType discount priceGroup email addressLine1 addressLine2 city stateCode postalCode countryCode forceSaveCustomer	xs:string xs:string xs:string xs:string xs:string xs:string xs:int xs:string xs:int xs:string xs:string xs:string xs:string xs:string xs:string xs:string xs:boolean	PathParam PathParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam	CustomerStatus

Item API

The following table describes the Item API:

URL	HTTP Method	Parameters			Return Type
		Name	Data Type	Kind
mobilepos/services/item/1.0/{storeID}/{registerID}/{itemNumber}/inventory/{otherStore}/{minimumQuantity}
inventoryLookup	GET	otherStore registerID minimumQuantity itemNumber storeID	xs:string xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam	InventoryStatus
mobilepos/services/item/1.0/{storeID}/{registerID}/{itemNumber}/inventory
inventoryLookup	GET	registerID itemNumber storeID	xs:string xs:string xs:string	PathParam PathParam PathParam	InventoryStatus
mobilepos/services/item/1.0/{storeID}/{registerID}
getGiftcardBalance	POST	registerID storeID account	xs:string xs:string xs:string	PathParam PathParam FormParam	GiftCardStatus
mobilepos/services/item/1.0/{storeID}/{registerID}/{itemNumber}
searchItem	GET	registerID itemNumber storeID webstoreLookup	xs:string xs:string xs:string xs:boolean	PathParam PathParam PathParam QueryParam	ItemStatus

Order API

The following table describes the Order API:

URL	HTTP Method	Parameters			Return Type
		Name	Data Type	Kind
mobilepos/services/order/1.0/{storeID}/{registerID}/ordertransactioncreate
createOrderTransaction	POST	registerID storeID orderID	xs:string xs:string xs:string	PathParam PathParam FormParam	TransactionStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/loadExternalOrder/{extOrderID}
loadExternalOrder	GET	extOrderID registerID storeID async suspend	xs:string xs:string xs:string xs:boolean xs:boolean	PathParam PathParam PathParam QueryParam QueryParam	TransactionStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/postExternalOrder/{extOrderID}
postExternalOrder	POST	extOrderID registerID storeID async	xs:string xs:string xs:string xs:boolean	PathParam PathParam PathParam QueryParam	TransactionStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/orderretrieval
retrieveOrders	POST	registerID storeID orderID customerID customerFirstName customerLastName customerPhoneNumber businessCustomerName	xs:string xs:string xs:string xs:string xs:string xs:string xs:string xs:string	PathParam PathParam FormParam FormParam FormParam FormParam FormParam FormParam	OrderStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/orderlineitemquantity
updateOrderLineItemQuantities	POST	registerID storeID orderID lineNumber pickupQuantity	xs:string xs:string xs:string xs:int xs:string	PathParam PathParam FormParam FormParam FormParam	OrderStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/orderlineitemserial
updateOrderLineItemSerialNumber	POST	registerID storeID orderID lineItemNumber serialNumber	xs:string xs:string xs:string xs:int xs:string	PathParam PathParam FormParam FormParam FormParam	OrderStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/orderprocesscancel
cancelOrderProcessing	DELETE	registerID storeID	xs:string xs:string	PathParam PathParam	OrderStatus
mobilepos/services/order/1.0/{storeID}/{registerID}/orderpickupstatus
updateOrderPickupStatus	POST	registerID storeID	xs:string xs:string	PathParam PathParam	OrderStatus

Register API

The following table describes the Register API:

URL	HTTP Method	Parameters			Return Type
		Name	Data Type	Kind
mobilepos/services/register/1.0/profile
getRegisterProfile	POST	hardwareID locale	xs:string xs:string	FormParam FormParam	RegisterProfileConfiguration
mobilepos/services/register/1.0/{storeID}/{registerID}
openRegister	GET	registerID storeID	xs:string xs:string	PathParam PathParam	RegisterStatus
mobilepos/services/register/1.0/{storeID}/{registerID}
closeRegister	DELETE	registerID storeID	xs:string xs:string	PathParam PathParam	RegisterStatus
mobilepos/services/register/1.0/profile/{registerID}
getRegisterProfileByRegisterID	POST	registerID locale	xs:string xs:string	PathParam QueryParam	RegisterProfileConfiguration

Sale Transaction API

The following table describes the Sale Transaction API:

URL	HTTP Method	Parameters			Return Type
		Name	Data Type	Kind
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/tenderlineitem/{tenderLineNumber}/idverified/{idVerified}
updateTenderLineItemCustomerIDVerified	GET	idVerified registerID storeID txnID tenderLineNumber	xs:boolean xs:string xs:string xs:string xs:int	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/printreceipt
printReceipt	GET	registerID storeID txnID printerID printMultipleGiftReceipt isPrintCustomerCopy	xs:string xs:string xs:string xs:string xs:boolean xs:boolean	PathParam PathParam PathParam QueryParam QueryParam QueryParam	ReceiptStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/customerlink
linkCustomer	POST	registerID storeID txnID customerID	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam FormParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{itemID}
addLineItem	GET	itemID registerID storeID txnID	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/tenderlineitem/{tenderAmount}
addTenderLineItem	GET	registerID storeID tenderAmount txnID	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/discount/percent/{percentOff}/reasoncode/{reasonCode}
addDiscount	GET	registerID reasonCode storeID txnID percentOff	xs:string xs:string xs:string xs:string xs:double	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/discount/amount/{amountOff}/reasoncode/{reasonCode}
addDiscount	GET	registerID reasonCode amountOff storeID txnID	xs:string xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/signatureadd
addSignature	POST	registerID storeID txnID tenderLineNumber signature noSignatureCapture	xs:string xs:string xs:string xs:int xs:string xs:boolean	PathParam PathParam PathParam FormParam FormParam FormParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/emailreceipt/{emailAddress}
emailReceipt	GET	registerID storeID emailAddress txnID printMultipleGiftReceipt	xs:string xs:string xs:string xs:string xs:boolean	PathParam PathParam PathParam PathParam QueryParam	ReceiptStatus
mobilepos/services/saletxn/{storeID}/{registerID}/cancelSuspended/{txnID}
cancelSuspendedSaleTransaction	GET	registerID storeID txnID	xs:string xs:string xs:string	PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/suspend
suspendTransaction	POST	registerID storeID txnID reasonCode	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam QueryParam	TransactionStatus
mobilepos/services/saletxn/{storeID}/{registerID}/{txnID}/associate/{associateID}
updateSalesAssociate	GET	registerID associateID storeID txnID	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/priceoverride/{price}/reasoncode/{reasonCode}
updateLineItemPrice	GET	lineItemNumber price registerID reasonCode storeID txnID	xs:int xs:string xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{itemID}/amount/{amount}
addGiftcardLineItem	POST	amount itemID registerID storeID txnID account	xs:string xs:string xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam FormParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}
deleteLineItem	DELETE	lineItemNumber registerID storeID txnID	xs:int xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/tenderlineitem/{tenderLineNumber}
voidTenderLineItem	DELETE	registerID storeID txnID tenderLine Number	xs:string xs:string xs:string xs:int	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}
getSaleTransaction	GET	registerID storeID	xs:string xs:string	PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/newcustomerlink
linkNewCustomer	POST	registerID storeID txnID firstName lastName businessName phoneNumber phoneType discount priceGroup email addressLine1 addressLine2 city stateCode postalCode countryCode forceSaveCustomer	xs:string xs:string xs:string xs:string xs:string xs:string xs:string xs:int xs:string xs:int xs:string xs:string xs:string xs:string xs:string xs:string xs:string xs:boolean	PathParam PathParam PathParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam FormParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}
cancelSaleTransaction	DELETE	registerID storeID txnID	xs:string xs:string xs:string	PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/resume/{txnID}
resumeSaleTransaction	GET	registerID storeID txnID	xs:string xs:string xs:string	PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/suspendedtransactions
getSuspendedTransactionsList	GET	registerID storeID	xs:string xs:string	PathParam PathParam	SuspendedTransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/quantity/{quantity}
updateLineItemQuantity	GET	lineItemNumber registerID quantity storeID txnID	xs:int xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/associate/{associateID}
updateLineItemSalesAssociate	GET	lineItemNumber registerID associateID storeID txnID	xs:int xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/serial/{serialNumber}
updateLineItemSerialNumber	GET	lineItemNumber registerID serialNumber storeID txnID force	xs:int xs:string xs:string xs:string xs:string xs:boolean	PathParam PathParam PathParam PathParam PathParam QueryParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/giftreceipt
updateLineItemGiftReceipt	GET	lineItemNumber registerID storeID txnID	xs:int xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/giftreceipt
updateTransactionGiftReceipt	GET	registerID storeID txnID	xs:string xs:string xs:string	PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/accountreentry
updateGiftcardAccount	POST	registerID storeID txnID account	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/discount/percent/{percentOff}/reasoncode/{reasonCode}
updateLineItemDiscount	GET	lineItemNumber registerID reasonCode storeID txnID percentOff	xs:int xs:string xs:string xs:string xs:string xs:double	PathParam PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/discount/amount/{amountOff}/reasoncode/{reasonCode}
updateLineItemDiscount	GET	lineItemNumber registerID reasonCode amountOff storeID txnID	xs:int xs:string xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/damagediscount/percent/{percentOff}
updateLineItemDamageDiscount	GET	lineItemNumber registerID storeID txnID percentOff	xs:int xs:string xs:string xs:string xs:double	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/lineitem/{lineItemNumber}/damagediscount/amount/{amountOff}
updateLineItemDamageDiscount	GET	lineItemNumber registerID amountOff storeID txnID	xs:int xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/callreferral/{tenderAmount}/{approvalCode}
addCallReferralTender	GET	registerID approvalCode storeID tenderAmount txnID cardType	xs:string xs:string xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam PathParam QueryParam	TransactionStatus
mobilepos/services/saletxn/1.0/{storeID}/{registerID}/{txnID}/suspend/{reasonCode}
suspendSaleTransaction	POST	registerID reasonCode storeID txnID	xs:string xs:string xs:string xs:string	PathParam PathParam PathParam PathParam	TransactionStatus