KIBO OMS DOCUMENTATION

Transactional Logs

Kibo OMS makes Transactional Logs (TLogs) available to clients as an accounting tool intended for reconciliation purposes. Three TLogs are sent and each captures information spanning a single calendar day: Sales, Credits, Returns. These reports include information regarding the specifics of each order captured, including payment type.

Kibo Engineering sets up the cron (scheduled job) that runs at a preset time to create these logs, such as every 15 minutes for interval logs and at 23:00 for an end of day log. Note that file sizes might affect the possible interval times.

Single Calendar Day Sales Reporting

Sales transactional logs include information for all sales made on a single calendar day.  Logs display total transaction information for each order and include order, shipping, billing, item, and shipment information. In addition to accounting uses, the Sales TLog can be used to communicate order and shipment data to in-house distribution centers. Data is reported at order and shipment levels. Shipment has to be fulfilled to show up on the Sales TLog.

SALES TLOG EXAMPLE: http://www.shopatron.com/xsd/tlog/v4/TLogSales.xml

SALES TLOG XSD: http://www.shopatron.com/xsd/tlog/v4/TLogSales.xsd

To see a detailed schema of all parameters in this log, expand the accordion below.

ElementChild ElementAttributeDescriptionFormatExample
salestotals
sale
totalstotal
totaltenderSum of all the buy tender by type
currencyTypeInternational Standards Organization CodeCurrency CodeUSD, CAD, etc
recordsNumber of SalesInteger(nonnegative“10”
salesCapturesTotal amount of capturesDecimal (2 places)“100.00”
uniqueStoresCountNumber of unique storesInteger(nonnegative)“10”
itemCountTotal number of line itemsInteger“10”
itemQuantityCountSum of the all the quantity of all the line itemsInteger(nonnegative)“100”
tendertypePayment typeString“CS”
amountTotal amount Decimal (2 places)“10.00”
countNumber of capturesDecimal (2 places)“10.00”
salecustomData
billing
shipping
item
orderIDA unique number assigned to an orderInteger“40001482”
externalOrderIDExternal order id passed in from a head in system on order creationStringTest_AG_448_1480452433"
shipmentIDUnique number assigned to a shipmentInteger“14181436”
customerIDUnique number assigned to a customerInteger“10237458”
storeIDUnique store identificationString“0001”
orderDateDate the order was placedDateTime“2017-05-15T00:15:57+00:00”
shipDateDate the order was shippedDateTime“2016-05-15T08:00:00+00:00”
fulfillerTotalAmount the retailer made on the transactionDecimal(2 places)“10.00”
customerTotalTotal the customer paidDecimal(2 places)“10.00”
shippingFeeSum of all fees paid for shippingDecimal(2 places)“10.00”
totalTaxSum of the tax paidDecimal(2 places)“10.00”
currencyTypeInternational Standards Organization CodeCurrency CodeUSD, CAD, etc
giftOrderDenotes if the order was a gift orderBooleanTrue, False
shippingaddress
label
firstNameShipping addressee first nameString“Jane”
lastNameShipping addressee last name(Optional)String“Doe”
emailShipping addressee email(Optional)String
message(Optional)String
labelcarrierShipment CarrierStringUSPS, UPS, etc
shippingType(Optional)String“UPS_NEXT_DAY_AIR”
trackingNumberUnique number assigned to the package by the carrierString“Z199999999999”
transitTimeEstimated time of arrival for the shipmentString“3 – 5 days”
billingaddress
payment
firstNameBilling first nameString“Jane”
lastNameBilling last nameString“Doe”
emailBilling emailString“Jane.Doe@email.com”
paymenttransaction
typePayment typeString“CS”
subTypePayment subtypeString“VI”
cardNumber6/4 mask of the credit card used for credit card tender types (optional)String111111XXXXXX1111"
transactiontypeType of transaction that occurredString“CAPTURE”, “CREDIT”
transactionIDUnique number assigned to the transactionString“47992191446704011”
transactionDateDate the transaction occurredString“2016-12-08T00:15:58-08:00”
amountTotal of the transactionDecimal(2 places)“10.00”
itemunit
customData
itemIDUnique number assigned to the itemInteger25675930" partNumber
partNumberUnique ID assigned to an item(Optional)String006-94100-02-0" UPC
UPCUnique number assigned to an item. Typically 12 digits(Optional)String657107883144" SKU
SKUInternal unique number assigned to a product (Optional)String“V8192D4R”
productNameName assigned to a product (Optional)String“Test_Product”
quantityNumber purchasedInteger“100”
retailPriceThe retail price or original price of the productDecimal(2 places)“10.00”
actualPriceThe actual price of the item paid by the customerDecimal(2 places)“10.00”
fulfillerTotalThe value the fulfiller will receiveDecimal“10.00”
customerTotalTotal paid by the customerDecimal(2 places)“10.00”
taxTax applied to the itemDecimal(2 places)“10.00”
shippingTaxTax applied to shipping cost(Optional)Decimal(2 places)“10.00”
unitserialNumberSerial number for the productString“12345”
customdataname(Optional)String“dwUUID”
value(Optional)String32f1fc2ef78852a0056be1a50b"
addressaddress1String“127 Alexander Ave”
address2(Optional)String“#323”
address3(Optional)String
cityString“Lake Grove”
countryCodeString“US”
stateString“NY”
zipString“11755”
phone(Optional)String“555-555-5555”

Single Calendar Day Credits Reporting

Credits TLogs relay the order data for all cancelled orders occurring on a single calendar day. Only for goodwill credits.

CREDITS TLOG EXAMPLE: http://www.shopatron.com/xsd/tlog/v4/TLogCredits.xml

CREDITS TLOG XSD: http://www.shopatron.com/xsd/tlog/v4/TLogCredits.xsd

To see a detailed schema of all parameters in this log, expand the accordion below.

ElementChild ElementAttributeDescriptionFormatExample
creditstotals
order
totalstotal
totaltender
currencyTypeInternational Standards Organization CodeCurrency CodeUSD, CAD, etc
creditsNumber of creditsInteger (Nonnegative)“1”
creditCreditsDollar amount of creditsDecimal (2 places)“10.00”
ordersNumber of ordersInteger (Nonnegative)“1”
paidByShopatronAmount of credits paid by ShopatronInteger (Nonnegative)“1”
paidByManufacturerAmount of credits paid by the manufacturerInteger (Nonnegative)“1”
paidByRetailerAmount of credits paid by retailerInteger (Nonnegative)“1”
tendertypePayment TypeString“CS”
amountTotal amountDecimal (2 places)“10.00”
countNumber of capturesDecimal (2 places)“10.00”
ordercustomer
customData
billing
credit
orderIDA unique number assigned to an orderInteger“40001482”
billingaddress
payment
firstNameBilling first nameString“Jane”
lastNameBilling last nameString“Doe”
emailBilling emailString“Jane.Doe@email.com”
addressaddress1String“127 Alexander Ave”
address2(Optional)String“#323”
address3(Optional)String
cityString“Lake Grove”
countryCodeInternational Standards Organization CodeString“US”
stateString“NY”
zipString“11755”
phone(Optional)String“555-555-5555”
paymenttransaction
typePayment typeString"CS"
subtypePayment subtypeString“VI”
cardNumber6/4 mask of the credit card used for credit card tender types (optional)String111111XXXXXX1111"
expirationExpiration date of the credit card (Optional)String“01_2017”
transactiontypeType of transactionString“CAPTURE”, “CREDIT”
transactionIDUnique ID assigned to the transationString“47992191446704011”
transactionDateDate the transaction occurredString“2016-12-08T00:15:58-08:00”
amountTotal for the transactionDecimal (2 places)“10.00”
customercustomerIDUnique number assigned to a customerInteger (Nonnegative)“10237458”
firstNameCustomer first name(Optional)String“Jane”
lastNameCustomer last name(Optional)String“Doe”
emailCustomer emailString“Jane.Doe@email.com”
creditcurrencyTypeInternational Standards Organization CodecurrencyCodeUSD, CAD, etc
AmountAmount of the creditDecimal (2 places)“10.00”
creditDateWhen the credit was issueddateTime2016-12-08T02:24:49-08:00"
notesReason an order was credited (Optional)String“Order Arrived Late”
paidByWhom the credit was paid byString“Retailer”
customDatanameString“dwUUID”
valueString32f1fc2ef78852a0056be1a50b"

Single Calendar Day Returns Reporting

Returns TLogs relay the order data for all returned orders occurring on a single calendar day. Returns that have been refunded will appear on the Returns TLog.

RETURNS TLOG EXAMPLE: http://www.shopatron.com/xsd/tlog/v4/TLogReturns.xml

RETURNS TLOG XSD: http://www.shopatron.com/xsd/tlog/v4/TLogReturns.xsd

To see a detailed schema of all parameters in this log, expand the accordion below.

ElementChild ElementAttributeDescriptionFormatExample
returnstotals
return
totalstotal
totaltenderSum of all the buy tender by type
currencyTypeInternational Standards Organization CodeCurrency CodeUSD, CAD, etc
recordsNumber of returnsInteger (nonnegative)“10”
returnCreditsAmount creditedDecimal (2 places)“10.00”
uniqueStoresCountNumber of unique storesInteger (nonnegative)“10”
itemCountTotal number of line itemsInteger“10”
itemQuantityCountSum of all the quantity of all the line itemsInteger (nonnegative)“100”
tendertypePayment TypeString“CS”, “CC”, “GC”
amountTotal amountDecimal (2 places)“10.00”
countNumber of capturesDecimal (2 places)“10.00”
returncustomData
billing
rmaIDUnique number generated by KiboInteger“598528”
orderIDUnique number assigned to an orderInteger“40001482”
externalOrderIdExternal order id passed in from a head in system on order creationStringTest_AG_448_1480452433"
shipmentIDUnique number assigned to a shipmentInteger“14181436”
customerIDUnique number assigned to a customerInteger“10237458”
fulfillerTotalAmount the fulfiller will receive from the returnDecimal (2 places)“10.00”
customerTotalAmount the customer will receive from the returnDecimal (2 places)“10.00”
totalTaxTotal tax appliedDecimal (2 places)“10.00”
returnReductionsReduction applied to the returnDecimal (2 places)“10.00”
returnToStoreIDStore ID where the product was returned Integer“0001”
returnDateDate the product was returnedString2016-12-05 02:23:58" currencyType
billingaddress
payment
firstNameBilling first nameString“Jane”
lastNameBilling last nameString“Doe”
emailBilling emailString“Jane.Doe@email.com”
addressaddress1String“127 Alexander Ave”
address2(Optional)String“#323”
address3(Optional)String
cityString“Lake Grove”
countryCodeString“US”
stateString“NY”
zipString“11755”
phone(Optional)String“555-555-5555”
paymenttransaction
typePayment typeString“CS”, “CC”
subTypePayment subtypeString“VI”
cardNumber6/4 mask of the credit card used for credit card tender types (optional)String111111XXXXXX1111"
expirationExpiration date of the credit card (Optional)String“01_2017”
transactiontypeType of transactionString“AUTHORIZE”, “CAPTURE”, “CREDIT”
transactionIDUnique ID assigned to the transationString“47992191446704011”
transactionDateDate the transaction occurredString“2016-12-08T00:15:58-08:00”
amountTotal for the transactionDecimal(2 places)“10.00”
itemunit
customData
itemIDUnique number assigned to the itemInteger25675930"
partNumberUnique ID assigned to an item(Optional)String006-94100-02-0" UPC
UPCUnique number assigned to an item. Typically 12 digits(Optional)String657107883144"
SKUInternal unique number assigned to a product (Optional)String“V8192D4R”
returnReasonReason the product was returnedString“Damaged”
quantity Amount of products returnedInteger“100”
acutalPricePrice that was paid by the customer for the itemDecimal (2 places)“10.00”
fulfillerSubtotalAmount the fulfiller will receive for the return of the itemDecimal (2 places)“10.00”
customerSubtotalAmount the customer will be reimbursed for the item Decimal (2 places)“10.00”
taxCreditAmount of tax the customer will be reimbursedDecimal (2 places)“10.00”
unitserialNumberUnique number for that itemString“12345”
customDatanameString“dwUUID”
valueString32f1fc2ef78852a0056be1a50b"

Megan MayfieldOMS Dev: Transactional Logs