Poslog Services, Version 1.0

53 Poslog Services, Version 1.0

This chapter provides the information necessary to send messages contained in version 1.0 of the Poslog Services API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service described above.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v1_0/PoslogServices?wsdl

where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.

The information presented below describes the methods and classes.

The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.

The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used.

Note:

Authentication is required. See Introduction for information on creating and implementing an authentication key.

Methods

This section presents the methods used in Version 1.0 of the Poslog Services API.

postTransaction

PoslogType postTransaction(         TransactionType transaction)     throws RelateProcessingException

Variable	Required?	Description
`transaction`	(Optional)	Transaction information being posted.

The postTransaction method posts a transaction for processing.

This method returns a PoslogType element.

Classes

This section presents the classes used in Version 1.0 of the Poslog Services API.

AmountType

The getValue() function for the AmountType class returns a decimal value.

The AmountType class contains the following attributes:

Type	Attribute	Description
string	Action	Action associated with the amount.

AssociateType

The AssociateType class contains the following elements:

Type	Element	Description
string	AssociateID	ID of the associate.

AuthorizationType

The AuthorizationType class contains the following elements:

Type	Element	Description
string	AuthorizationCode	Authorization code returned.
string	AdjudicationCode	Adjudication code returned.
dateTime	AuthorizationDateTime	Date and time of the authorization.
string	ReferenceNumber	Reference number for the authorization.
decimal	RequestedAmount	Amount requested for authorization.

CheckType

The CheckType class contains the following elements:

Type	Element	Description
string	AccountNumber	Account number for the check.

CouponType

The CouponType class contains the following elements:

Type	Element	Description
string	ScanCode	Code scanned for the coupon.
dateTime	ExpirationDate	Expiration date of the coupon.

CreditDebitType

The CreditDebitType class contains the following elements:

Type	Element	Description
string	PrimaryAccountNumber	Account number of the credit or debit card.
string	ReconciliationCode	Reconciliation code for the credit or debit card.
dateTime	ExpirationDate	Expiration date for the credit or debit card.

CustomerAccountType

The CustomerAccountType class contains the following elements:

Type	Element	Description
string	LoyaltyAccount	Loyalty account associated with the customer.

CustomerOrderForDeliveryType

The CustomerOrderForDeliveryType class contains the following elements:

Type	Element	Description
string	ItemID	ID of the ordered item.
decimal	UnitCostPrice	Cost of one ordered item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one ordered item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one ordered item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the ordered item.
decimal	Quantity	Quantity of the ordered item.
string	SerialNumber	Serial number of the ordered item.
AssociateType	Associate	Associate who entered the ordered item.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the ordered item price.
PercentageOfItemType	PercentageOfItem	Percentage of the ordered item.
DeliveryType	Delivery	Delivery information for the item.
string	InventoryReservationID	ID of the inventory reservation.
string	From	Name used in the From: information.

The CustomerOrderForDeliveryType class contains the following attributes:

Type	Attribute	Description
string	Action	Action for the item.
string	ItemType	ID for the type of item.
string	Setup	Setup information for the item.

CustomerOrderForPickupType

The CustomerOrderForPickupType class contains the following elements:

Type	Element	Description
string	ItemID	ID of the ordered item.
decimal	UnitCostPrice	Cost of one ordered item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one ordered item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one ordered item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the ordered item.
decimal	Quantity	Quantity of the ordered item.
string	SerialNumber	Serial number of the ordered item.
AssociateType	Associate	Associate who entered the ordered item.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the ordered item price.
PercentageOfItemType	PercentageOfItem	Percentage of the ordered item.
DeliveryType	Delivery	Delivery information for the item.
string	InventoryReservationID	ID of the inventory reservation.
string	From	Name used in the From: information.

The CustomerOrderForPickupType class contains the following attributes:

Type	Attribute	Description
string	ItemType	ID for the type of item.
string	OrderStatus	Status of the order.
string	Action	Action for the item.

CustomerVerificationType

The CustomerVerificationType class contains the following elements:

Type	Element	Description
PersonalIDType	PersonalID	Information about the personal ID used to verify the customer’s identity.

DeliveryType

The DeliveryType class contains the following elements:

Type	Element	Description
string	Name	Name of person to whom the delivery is being sent.
PoslogAddressType	Address	Delivery address.
string	TelephoneNumber	Telephone number associated with the delivery.
string	TrackingNumber	Delivery tracking number.

GiftCardType

The GiftCardType class contains the following elements:

Type	Element	Description
string	CardNumber	Card number of gift card.
string	DateSold	Date the gift card was sold.
string	IntialBalance	Initial balance on the gift card.
string	CurrentBalance	Current balance of the gift card.
AuthorizationType	Authorization	Authorization information for the gift card.

LineItemType

The LineItemType class contains the following elements:

Type	Element	Description
string	SequenceNumber	Sequence number of the line item.
string	BeginDateTime	Date and time at which the line item was started.
string	EndDateTime	Date and time at which the line item was completed.
SaleForDeliveryType	SaleForDelivery	Information for sale for delivery item.
PreviousLayawayType	PreviousLayaway	Information for a previous layaway.
PreviousCustomerOrderType	PreviousCustomerOrder	Information for a previous customer order.
CustomerOrderForDeliveryType	CustomerOrderForDelivery	Information for a customer order for delivery.
CustomerOrderForPickupType	CustomerOrderForPickup	Information for a customer order for pickup.
ReturnType	Return	Information for a returned item.
SaleType	Sale	Information for a sold item.
TenderType	Tender	Information about a tender applied to the transaction.
TaxType	Tax	Information about a tax applied to the transaction.
string	DocumentType	Type of document.
string	ActivityCode	ID code for the item activity.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the layaway item price.

The LineItemType class contains the following attributes:

Type	Attribute	Description
boolean	VoidFlag	Indicates whether the line item has been voided.

LoyaltyAccountType

The LoyaltyAccountType element contains the following elements:

Type	Element	Description
string	LoyaltyAccountID	ID of a loyalty account.

The LoyaltyAccountType element contains the following attributes:

Type	Attribute	Description
string	TypeCode	ID code for the type of loyalty account.,

LoyaltyPointsType

The LoyaltyPointsType class contains the following elements:

Type	Element	Description
string	LoyaltyAccountID	ID of the loyalty account.
string	LoyaltyProgramID	ID of the loyalty program to which the account belongs.
string	LoyaltyProgramLevelID	ID of the program level to which the account belongs.
PointsBalanceType	PointsBalance	Current points balance.
TransactionsPointsType	TransactionPoints	Points for the transaction.

PercentageOfItemType

The PercentageOfItemType class contains the following elements:

Type	Element	Description
string	AssociateID	Associate ID.
decimal	Percentage	Percentage of item.

PersonalIDType

The PersonalIDType class contains the following elements:

Type	Element	Description
string	IDNumber	ID number for the personal identification.
string	Issuer	Entity that issued the identification.
string	Province	Province/State associated with the identification.

The PersonalIDType class contains the following attributes:

Type	Attribute	Description
string	IDType	ID code for the type of identification.

PointsBalanceType

The PointsBalanceType class contains the following attributes:

Type	Attribute	Description
PointsEntryType[]	Points	Array of point balances and point types in the account.

PointsEntryType

The getValue() function for the PointsEntryType class returns a string value.

The PointsEntryType class contains the following attributes:

Type	Attribute	Description
PointsType	Type	Points Type.

POSIdentity

The POSIdentity class contains the following elements:

Type	Element	Description
string	POSItemID	ID of the item in POS.

PoslogAddressType

The PoslogAddressType class contains the following elements:

Type	Element	Description
string	AddressLine	Line 1 of the address.
string	City	City of the address.
string	State	State/province of the address.
string	PostalCode	Postal/ZIP code of the address.
string	CountryCode	ID code of the country of the address.

PoslogAlternateKeyType

The PoslogAlternateKeyType class contains the following elements:

Type	Element	Description
string	AlternateID	ID of the Alternate Key

The PoslogAlternateKeyType class contains the following attributes:

Type	Attribute	Description
string	TypeCode	ID code for the type of alternate key.

PoslogCustomerType

The PoslogCustomerType class contains the following elements:

Type	Element	Description
string	Name	Customer name.
PoslogAddressType	Address	Customer address.
string	TelephoneNumber	Customer telephone number.
string	eMail	Customer email address.
string	CustomerID	Customer account number.
PoslogAlternateKeyType[]	AlternateKey	Alternate keys identifying the customer.

PoslogType

The PoslogType class contains the following elements:

Type	Element	Description
TransactionReturnType	Transaction	Response to the transaction posted.

PosTransactionPropertiesType

The PosTransactionPropertiesType class contains the following elements:

Type	Element	Description
string	PosTransactionPropertyCode	ID code for the POS transaction property.
string	PosTransactionPropertyValue	Value of the POS transaction property.

PreviousCustomerOrderType

The PreviousCustomerOrderType class contains the following elements:

Type	Element	Description
string	ItemID	ID of the item.
decimal	UnitCostPrice	Cost of one item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the item.
decimal	Quantity	Quantity of the item.
string	SerialNumber	Serial number of the item.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the item price.
AssociateType	Associate	Associate who entered the item.
PercentageOfItemType	PercentageOfItem	Percentage of the item.
string	InventoryReservationID	ID of the inventory reservation.

The PreviousCustomerOrderType class contains the following attributes:

Type	Attribute	Description
string	ItemType	ID for the type of item.
string	Action	Action for the item.

PreviousLayawayType

The PreviousLayawayType class contains the following elements:

Type	Element	Description
POSIdentity Type	POSIdentity	Identifier for the layaway in the POS system.
string	ItemID	ID of the layaway item.
decimal	UnitCostPrice	Cost of one layaway item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one layaway item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one layaway item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the layaway item.
decimal	Quantity	Quantity of the layaway item.
string	SerialNumber	Serial number of the layaway item.
AssociateType	Associate	Associate who entered the layaway item.
PercentageOfItemType	PercentageOfItem	Percentage of the layaway item.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the layaway item price.

The PreviousLayawayType class contains the following attributes:

Type	Attribute	Description
string	Action	Action for the layaway item.
string	ItemType	ID for the type of the layaway item.

RelateProcessingException

For a description of this class, see Introduction.

RetailPriceModifierType

The RetailPriceModifierType class contains the following elements:

Type	Element	Description
string	SequenceNumber	Sequence number of the price modification.
AmountType	Amount	Amount of the modification.
string	PromotionID	ID of the promotion associated with the price modification.
string	ReasonCode	ID code for the reason the price was modified.
CouponType	Coupon	Coupon associated with the price modification.

The RetailPriceModifierType class contains the following attributes:

Type	Attribute	Description
boolean	VoidFlag	Indicates whether the price modifier has been voided.

RetailTransactionType

The RetailTransactionType class contains the following elements:

Type	Element	Description
LineItemType[]	LineItem	Transaction line item(s).
TotalType[]	Total	Total types for the transaction.
CustomerAccountType	CustomerAccount	Customer account associated with the transaction.
PoslogCustomerType	Customer	Customer associated with the transaction.
TransactionLinkType	TransactionLink	Link to associated transaction.
string	PostVoidReasonCode	Reason code for a post void of the retail transaction.
string	PostVoidComment	Comment entered for a post void of the retail transaction.

The RetailTransactionType class contains the following attributes:

Type	Attribute	Description
string	Version	The version of the retail transaction definition.
string	TypeCode	ID code of the retail transaction type.
string	TransactionStatus	Status of the retail transaction.

ReturnType

The ReturnType class contains the following elements:

Type	Element	Description
string	ItemID	ID of the returned item.
decimal	UnitCostPrice	Cost of one returned item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one returned item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one returned item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the returned item.
decimal	Quantity	Quantity of the layaway item.
string	SerialNumber	Serial number of the returned item.
AssociateType	Associate	Associate who entered the returned item.
PercentageOfItemType	PercentageOfItem	Percentage of the returned item.
TransactionLinkType	TransactionLink	Link to the transaction in which the item was sold.
string	Disposal	How the returned item was disposed of.
string	Reason	Reason for the return.
string	ReturnType	ID for the type of return.
string	ReasonComment	Additional comment about the reason for the return.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the layaway item price.

The ReturnType class contains the following attributes:

Type	Attribute	Description
string	ItemType	ID for the type of item.
string	Action	Action for the item.

SaleForDeliveryType

The SaleForDeliveryType class contains the following elements:

Type	Element	Description
string	ItemID	ID of the returned item.
decimal	UnitCostPrice	Cost of one returned item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one returned item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one returned item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the layaway item.
decimal	Quantity	Quantity of the layaway item.
string	SerialNumber	Serial number of the layaway item.
AssociateType	Associate	Associate who entered the layaway item.
PercentageOfItemType	PercentageOfItem	Percentage of the layaway item.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the layaway item price.
DeliveryType	Delivery	Delivery destination information.

The SaleForDeliveryType class contains the following attributes:

Type	Attribute	Description
string	Action	Action for the item.
string	ItemType	ID for the type of item.

SaleType

The SaleType class contains the following elements:

Type	Element	Description
string	ItemID	ID of the sold item.
decimal	UnitCostPrice	Cost of one sold item unit.
decimal	RegularSalesUnitPrice	Regular sale price of one sold item unit.
decimal	ActualSalesUnitPrice	Actual sale price of one sold item unit in this transaction.
decimal	ExtendedAmount	Total amount of the sale of the item.
decimal	Quantity	Quantity of the sold item.
string	SerialNumber	Serial number of the sold item.
AssociateType	Associate	Associate who entered the sold item.
PercentageOfItemType	PercentageOfItem	Percentage of the sold item.
RetailPriceModifierType[]	RetailPriceModifier	Modifiers that have been applied to the sold item price.

The SaleType class contains the following attributes:

Type	Attribute	Description
string	Action	Action for the item.
string	ItemType	ID for the type of item.

TaxExemptionType

The TaxExemptionType class contains the following elements:

Type	Element	Description
string	CustomerExemptionID	ID of the exemption used by the customer.
string	ExemptTaxAmount	Amount of tax exempted.

TaxOverrideType

The TaxOverridType class contains the following elements:

Type	Element	Description
decimal	OriginalPercent	Tax percentage prior to the override.
decimal	OriginalTaxAmount	Tax amount prior to the override.
decimal	NewTaxPercent	Tax percentage applied by the override.
decimal	NewTaxAmount	Tax amount applied by the override.
string	ReasonCode	ID code for the reason for the tax override.

TaxType

The Taxype class contains the following elements:

Type	Element	Description
string	TaxAuthority	ID of the tax authority through which the tax was applied.
decimal	TaxableAmount	Amount to which the tax is applied.
decimal	Amount	Amount of the tax.
decimal	Percent	Percentage used to determine the tax.
string	TaxLocationID	ID of the tax location.
TaxExemptionType	TaxExemption	Tax exemption applied to the tax.
TaxOverrideType	TaxOverride	Tax override applied to the tax.

The TaxType class contains the following attributes:

Type	Attribute	Description
string	TaxType	Type of tax.

TenderType

The TenderType class contains the following elements:

Type	Element	Description
string	TenderID	ID of the tender.
decimal	Amount	Amount applied to the tender.
AuthorizationType	Authorization	Authorization information for the tender.
CreditDebitType	CreditDebit	Credit/Debit tender information.
GiftCardType	GiftCard	Gift card tender information.
VoucherType	Voucher	Voucher tender information.
CustomerVerificationType	CustomerVerification	Customer verification information.
CheckType	Check	Check tender information.
CouponType	Coupon	Coupon tender information.

The TenderType class contains the following attributes:

Type	Attribute	Description
string	TenderType	ID for the type of Tender.

TotalType

The getValue() function for the TotalType class returns a string value.

The TotalType class contains the following elements:

Type	Attribute	Description
string	TotalType	Type of total.

TransactionLinkType

The TransactionLinkType class contains the following elements:

Type	Element	Description
string	RetailStoreID	ID of the location where the transaction was performed.
string	WorkstationID	ID of the workstation where the transaction was performed.
string	SequenceNumber	Sequence number of the transaction.
date	BusinessDayDate	Business date of the transaction.

The TransactionLinkType class contains the following attributes:

Type	Attribute	Description
string	ReasonCode	ID code of the reason for linking to the transaction.
string	EntryMethod	Method by which the transaction link was entered.

TransactionsPointsType

The TransactionPointsType class contains the following elements:

Type	Element	Description
PointsEntryType[]	Points	Array of point balances and point types for the transaction.

TransactionReturnType

The TransactionReturnType class contains the following elements:

Type	Element	Description
string	ErrorDetails	Detailed message describing an error (if any) returned for the transaction.
string	LoyaltySystemDetails	Detailed message about the system.
LoyaltyPointsType[]	LoyaltyPoints	Array of information about loyalty points applied to loyalty accounts.

The TransactionReturnType class contains the following attributes:

Type	Attribute	Description
string	retail-transaction-id	ID of the retail transaction.
string	status	Status of the transaction.

TransactionType

The TransactionType class contains the following elements:

Type	Element	Description
string	RetailStoreID	ID of the location where the transaction was performed.
string	WorkstationID	ID of the workstation where the transaction was performed.
string	SequenceNumber	Sequence number of the transaction.
date	BusinessDayDate	Business date of the transaction.
dateTime	BeginDateTime	Date and time at which the transaction started.
dateTime	EndDateTime	Date and time at which the transaction ended.
string	OperatorID	ID of the person who performed the transaction.
string	CurrencyCode	ID code for the currency used in the transaction.
RetailTransactionType	RetailTransaction	Transaction information.
PosTransactionPropertiesType[]	PosTransactionProperties	Properties of the POS transaction.

The TransactionType class contains the following attributes:

Type	Attribute	Description
boolean	CancelFlag	Indicates whether the transaction was cancelled.
string	Action	Action performed by the transaction.
string	TransactionType	Type of transaction.

VoucherType

The VoucherType class contains the following elements:

Type	Element	Description
string	Description	Description of the voucher.
decimal	FaceValueAmount	Face value of the voucher.
string	SerialNumber	Serial number of the voucher.
string	MallCertificate	ID for mall certificate associated with the voucher.
string	ExpirationDate	Expiration date of the voucher.
decimal	UnspentAmount	Amount on the voucher that is currently unspent.

The VoucherType class contains the following attributes:

Type	Attribute	Description
string	TypeCode	ID code for the type of voucher.