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.

Codes and enum values used in TLogs match those in OMS REST APIs:

  • Orders are identified in the orderType enum as “STANDARD”, “MARKETPLACE_EBAY”, “CERTIFIED”, “CERTIFIED_FAILOVER”, “HYBRID”, “GIFT_CARD”, “STS_MANUAL”, “STS_AUTOMATED”, “STS_PLUS”, “SUBSCRIPTION”, “ISPU”, and “TRANSFER”.
  • Supported codes for currencies and payment types are the same as those found in the Create Order guide.

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. The shipment has to be fulfilled to show up on the Sales TLog. Additionally, Transfer (Ship to Store) order logs include an element parameter for the child order being transferred.

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

SALES TLOG EXAMPLE (TRANSFER)http://www.shopatron.com/xsd/tlog/v4/TLogTransfers.xml

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

The XSD file above is the master schema for the Sales TLog, but the schema is also readable below in plain text format.


sales

Description: The comprehensive element of the Sales log


totals

Description: Total sales reported in the log


total

Description: Total sales reported in the log


tender

Description: Sum of all the buy tender by type


Type

Description: Payment type

Format: String

Example: “CS”


Amount

Description: Total amount

Format: Decimal (2 places)

Example: “10.00”


Count

Description: Number of captures

Format: Decimal (2 places)

Example: “10.00”


currencyType

Description: International Standards Organization Code

Format: Currency Code

Example: USD


records

Description: Number of sales

Format: Integer (non-negative)

Example: “10”


salesTotal

Description: Total number of captures

Format: Decimal (2 places)

Example: “100.00”


totalTax

Description: Total number of tax

Format: Decimal (2 places)

Example: “100.00”


uniqueStoresCount

Description: Number of unique stores

Format: Integer (non-negative)

Example: “10”


itemCount

Description: Total number of line items

Format: Integer

Example: “10”


itemQuantityCount

Description: Sum of all the quantity of all the line items

Format: Integer (non-negative)

Example: “100”


sale

Description: A sale element for an order


transferOrder

Description: An optional element for a transfer order


childOrderID

Description: The ID of the child order of the transfer

Format: Integer

Example: "111"


customData

Description: Optional custom data that can be provided for the order


name

Description: The name of the custom data

Format: String

Example: “dwUUID”


value

Description: The value of the custom data

Format: String

Example: “32f1fc2ef78852a0056be1a50b”


billing

Description: Billing information for the order


address

Description: The billing address of the customer


address1

Description: The first line of the street address

Format: String

Example: “127 Alexander Ave”


address2

Description: The second line of the street address (optional)

Format: String

Example: “#323”


address3

Description: The third line of the street address (optional)

Format: String

Example: "#456"


city

Description: The city name of the billing address

Format: String

Example: “Lake Grove”


countryCode

Description: The country for the billing address

Format: String

Example: “US”


state

Description: The state for the billing address

Format: String

Example: "NY"


zip

Description: The zip code of the street address

Format: String

Example: “012345”


phone

Description: The phone number of the customer contact (optional)

Format: String

Example: “555-555-5555”


payment

Description: The payment information for the order


transaction

Description: The transaction details of the purchase


type

Description: Type of the transaction that occurred

Format: Transaction Type

Example: “CREDIT” or "CAPTURE"


transactionID

Description: Unique number assigned to the transaction

Format: String

Example: “47992191446704011”


transactionDate

Description: Date the transaction occurred

Format: String (date-time)

Example: “2016-12-08T00:15:58-08:00”


amount

Description: Total of the transaction

Format: String (2 decimals)

Example: “10.00”


transactionStatus

Description: The status of the transaction

Format: String

Example: "Success"


type

Description: Payment Type

Format: String

Example: “CS”


subType

Description: Payment subtype

Format: String

Example: “VI”


cardNumber

Description: 6/4 mask of the credit card used for credit card tender types (optional)

Format: String

Example: “111111XXXXXX1111”


expiration

Description: The optional expiration date of the card.

Format: String

Example: “01_2017”


firstName

Description: Billing first name

Format: String

Example: “janedoe@email.com”


lastName

Description: Billing last name

Format: String

Example: “Doe”


email

Description: Billing email

Format: String

Example: “janedoe@email.com”


shipping

Description: The shipping details of the order


address

Description: The shipping address for the order


address1

Description: The first line of the street address

Format: String

Example: “127 Alexander Ave”


address2

Description: The second line of the street address(optional)

Format: String

Example: “#323”


address3

Description: The third lien of the street address(optional)

Format: String

Example: "456"


city

Description: The city name of the shipping address

Format: String

Example: “Lake Grove”


countryCode

Description: The country for the shipping address

Format: String

Example: “US”


state

Description: The state for the shipping address

Format: String

Example: "NY"


zip

Description: The zip code for the shipping address

Format: String

Example: “012345”


phone

Description: The phone number for the shipping contact (optional)

Format: String

Example: “555-555-5555”


label

Description: The shipping label for the order


carrier

Description: Shipment carrier

Format: String

Example: “UPS”


shippingType

Description: The type of shipping provided by the carrier(optional)

Format: String

Example: “UPS_NEXT_DAY_AIR”


trackingNumber

Description: Unique number assigned to the package by the carrier

Format: String

Example: “Z199999999999”


transitTime

Description: Estimated time of arrival for the shipment

Format: String

Example: “3-5 days”


firstName

Description: Shipping addressee first name

Format: String

Example: “Jane”


lastName

Description: Shipping addressee last name (optional)

Format: String

Example: “Doe”


email

Description: Shipping addressee email (optional)

Format: String

Example: “janedoe@email.com”


message

Description: A message to be included with the shipment (optional)

Format: String

Example: “This is a gift to you.”


item

Description: The item details of the order


unit

Description: The details of an item unit in the order


serialNumber

Description: Serial number for the product

Format: String

Example: “12345”


customData

Description: Optional custom data for the item


name

Description: The name of the custom data

Format: String

Example: “dwUUID”


value

Description: The value of the custom data

Format: String

Example: “32f1fc2ef78852a0056be1a50b”


itemID

Description: Unique number assigned to the item

Format: Integer

Example: “25675930”


partNumber

Description: Unique ID assigned to an item(Optional)

Format: String

Example: “006-94100-02-0”


UPC

Description: Unique number assigned to an item. Typically 12 digits (optional)

Format: String

Example: “657107883144”


SKU

Description: Internal unique number assigned to a product (optional)

Format: String

Example: “V8192D4R”


productName

Description: Name assigned to a product (Optional)

Format: String

Example: “Test_Product”


quantity

Description: Number purchased

Format: Integer

Example: “100”


retailPrice

Description: The retail price or original price of the product

Format: Decimal (2 places)

Example: “10.00”


actualPrice

Description: The actual price of the item paid by the customer

Format: Decimal (2 places)

Example: “10.00”


fulfillerTotal

Description: The value the fulfiller will receive

Format: Decimal

Example: “10.00”


customerTotal

Description: Total paid by the customer

Format: Decimal (2 places)

Example: “10.00”


tax

Description: Tax applied to the item

Format: Decimal (2 places)

Example: “10.00”


shippingTax

Description: Tax applied to shipping cost (Optional)

Format: Decimal (2 places)

Example: “10.00”


orderID

Description: A unique number assigned to an order

Format: Integer

Example: “40001482”


externalOrderID

Description: External order id passed in from a head in system on order creation

Format: String

Example: “Test_AG_448_1480452433”


customerOrderNumber

Description: An optional custom order number

Format: String

Example: “01010101”


shipmentID

Description: Unique number assigned to a shipment

Format: Integer

Example: “14181436”


customerID

Description: Unique number assigned to a customer

Format: Integer

Example: “10237458”


storeID

Description: Unique store identification

Format: String

Example: “0001”


orderDate

Description: Date the order was placed

Format: String (date-time)

Example: “2017-05-15T00:15:57+00:00”


shipDate

Description: Date the order was shipped

Format: String (date-time)

Example: “2016-05-15T08:00:00+00:00”


fulfillerTotal

Description: Amount the retailer made on the transaction

Format: Decimal (2 places)

Example: “10.00”


customerTotal

Description: Total the customer paid

Format: Decimal (2 places)

Example: “10.00”


shippingFee

Description: Sum of all fees paid for shipping

Format: Decimal (2 places)

Example: “10.00”


totalTax

Description: Sum of the tax paid

Format: Decimal (2 places)

Example: “10.00”


currencyType

Description: Currency code in ISO 4217

Format: Currency Code

Example: USD


giftOrder

Description: Denotes if the order was a gift order

Format: Boolean

Example: True, False


orderType

Description: Denotes the type of order, see list of value options

Format: Order Type

Example: “STANDARD”

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

The XSD file above is the master schema for the Credits TLog, but the schema is also readable below in plain text format.


credits

Description: The comprehensive element of the Credits log


totals

Description: Total credits reported in the log


total

Description: Total credits reported in the log


tender

Description: Sum of all buy tender by type


type

Description:Payment Type

Format: String

Example: "CS"


amount

Description: Total amount

Format: Decimal (2 places)

Example: "10.00"


count

Description: Number of captures

Format: Decimal (2 places)

Example: "10.00"


currencyType

Description: International Standards Organization Code

Format: Currency Code

Example: "USD"


credits

Description: Number of credits

Format: Integer (non-negative)

Example: "1"


creditCredits

Description: Dollar amount of credits

Format: Decimal (2 places)

Example: "10.00"


orders

Description: Number of orders

Format: Integer (non-negative)

Example: "1"


paidByShopatron

Description: Amount of credits paid by Shopatron

Format: Integer (non-negative)

Example: "1"


paidByManufacturer

Description: Amount of credits paid by the manufacturer

Format: Integer (non-negative)

Example: "1"


paidByRetailer

Description: Amount of credits paid by the retailer

Format: Integer (non-negative)

Example: "1"


order

Description: Order details for the credits


customer

Description: Customer details for the order


customerID

Description: Unique number assigned to a customer

Format: Integer (non-negative)

Example: "10237458"


firstName

Description: Customer first name (optional)

Format: String

Example: "Jane"


lastName

Description: Customer last name (optional)

Format: String

Example: "Doe"


email

Description: Customer email

Format: String

Example: "janedoe@email.com"


customData

Description: Custom data for the order


name

Description: The name of the custom data

Format: String

Example: “dwUUID”


value

Description: The value of the custom data

Format: String

Example: “32f1fc2ef78852a0056be1a50b”


billing

Description: Billing information for the order


address

Description: Billing address for the order


address1

Description: The first line of the street address

Format: String

Example: “127 Alexander Ave”


address2

Description: The second line of the street address(optional)

Format: String

Example: “#323”


address3

Description: The third line of the street address(optional)

Format: String

Example: "456"


city

Description: The city name of the billing address

Format: String

Example: “Lake Grove”


countryCode

Description: The country for the billing address

Format: String

Example: “US”


state

Description: The state for the billing address

Format: String

Example: "NY"


zip

Description: The zip code for the billing address

Format: String

Example: “012345”


phone

Description: The phone number for the billing contact (optional)

Format: String

Example: “555-555-5555”


payment

Description: Payment information for the order


transaction

Description: The transaction information for the payment


type

Description: Transaction type

Format: String

Example: "CAPTURE" or "CREDIT"


transactionID

Description: Unique ID assigned to the transation

Format: String

Example: "47992191446704011"


transactionDate

Description: Date the transaction occurred

Format: String (date-time)

Example: "2016-12-08T00:15:58-08:00"


amount

Description: Total for the transaction

Format: Decimal (2 places)

Example: “10.00”


type

Description: Payment type

Format: String

Example: “CS”


subType

Description: Payment subtype

Format: String

Example: "VI"


cardNumber

Description: 6/4 mask of the credit card used for credit card tender types (optional)

Format: String

Example: "111111XXXXXX1111"


expiration

Description: Expiration date of the credit card (optional)

Format: String

Example: "01_2017"


firstName

Description: Billing first name

Format: String

Example: "Jane"


lastName

Description: Billing lastName

Format: String

Example: "Doe"


email

Description: Billing email

Format: String

Example: "janedoe@email.com"


credit

Description: Credit information for the order


currencyType

Description: International Standards Organization Code

Format: Currency Code

Example: "USD"


amount

Description: Amount of the credit

Format: Decimal (2 places)

Example: "10.00"


creditDate

Description: When the credit was issued

Format: String (date-time)

Example: "2016-12-08T02:24:49-08:00"


notes

Description: Reason an order was credited (optional)

Format: String

Example: "Order Arrived Late"


paidBy

Description: Whom the credit was paid by

Format: String

Example: "Retailer"


orderID

Description: A unique number assigned to an order

Format: Integer

Example: "40001482"

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

The XSD file above is the master schema for the Returns TLog, but the schema is also readable below in plain text format.


returns

Description: The comprehensive element of the Returns log


totals

Description: Total returns reported in the log


total

Description: Total returns reported in the log


tender

Description: Sum of all the buy tender by type


type

Description: Payment Type

Format: String

Example: "CC"


amount

Description: Total amount

Format: Decimal (2 places)

Example: "10.00"


count

Description: Number of captures

Format: Decimal (2 places)

Example: "10.00"


currencyType

Description: International Standards Organization Code

Format: Currency Code

Example: "USD"


records

Description: Number of returns

Format: Integer (non-negative)

Example: "10"


returnCredits

Description: Amount credited

Format: Decimal (2 places)

Example: "10.00"


uniqueStoresCount

Description: Number of unique stores

Format: Integer (non-negative)

Example: "10"


itemCount

Description: Total number of line items

Format: Integer

Example: "10"


itemQuantityCount

Description: Sum of all the quantity of all the line items

Format: Integer (non-negative)

Example: "100"


return

Description: The return information


customData

Description: Custom data for the order


name

Description: Name of the custom data

Format: String

Example: "dwUUID"


value

Description: Value of the custom data

Format: String

Example: "32f1fc2ef78852a0056be1a50b"


billing

Description: Billing information for the order


address

Description: The billing address for the order


address1

Description: The first line of the street address

Format: String

Example: “127 Alexander Ave”


address2

Description: The second line of the street address(optional)

Format: String

Example: “#323”


address3

Description: The third line of the street address(optional)

Format: String

Example: "456"


city

Description: The city name of the billing address

Format: String

Example: “Lake Grove”


countryCode

Description: The country for the billing address

Format: String

Example: “US”


state

Description: The state for the billing address

Format: String

Example: "NY"


zip

Description: The zip code for the billing address

Format: String

Example: “012345”


phone

Description: The phone number for the billing contact (optional)

Format: String

Example: “555-555-5555”


payment

Description: Payment information for the order


transaction

Description: The transaction information for the payment


type

Description: Transaction type

Format: String

Example: "CAPTURE" or "CREDIT"


transactionID

Description: Unique ID assigned to the transation

Format: String

Example: "47992191446704011"


transactionDate

Description: Date the transaction occurred

Format: String (date-time)

Example: "2016-12-08T00:15:58-08:00"


amount

Description: Total for the transaction

Format: Decimal (2 places)

Example: “10.00”


type

Description: Payment type

Format: String

Example: “CS”


subType

Description: Payment subtype

Format: String

Example: "VI"


cardNumber

Description: 6/4 mask of the credit card used for credit card tender types (optional)

Format: String

Example: "111111XXXXXX1111"


expiration

Description: Expiration date of the credit card (optional)

Format: String

Example: "01_2017"


firstName

Description: Billing first name

Format: String

Example: “Jane”


lastName

Description: Billing last name

Format: String

Example: “Doe”


email

Description: Billing email

Format: String

Example: “janedoe@email.com”


item

Description: The item details of the order


unit

Description: The details of an item unit in the order


serialNumber

Description: Serial number for the product

Format: String

Example: “12345”


customData

Description: Optional custom data for the item


name

Description: The name of the custom data

Format: String

Example: “dwUUID”


value

Description: The value of the custom data

Format: String

Example: “32f1fc2ef78852a0056be1a50b”


itemID

Description: Unique number assigned to the item

Format: Integer

Example: "25675930"


partNumber

Description: Unique ID assigned to an item (optional)

Format: String

Example: "006-94100-02-0"


UPC

Description: Unique number assigned to an item. Typically 12 digits (optional)

Format: String

Example: "657107883144"


SKU

Description: Internal unique number assigned to a product (optional)

Format: String

Example: "V8192D4R"


returnReason

Description: Reason the product was returned

Format: String

Example: "Damaged"


quantity

Description: Amount of products returned

Format: Integer

Example: "100"


actualPrice

Description: Price that was paid by the customer for the item

Format: Decimal (2 places)

Example: "10.00"


fulfillerSubtotal

Description: Amount the fulfiller will receive for the return of the item

Format: Decimal (2 places)

Example: "10.00"


customerSubtotal

Description: Amount the customer will be reimbursed for the item

Format: Decimal (2 places)

Example: "10.00"


taxCredit

Description: Amount of tax the customer will be reimbursed

Format: Decimal (2 places)

Example: "10.00"


rmaID

Description: Unique number generated by Kibo

Format: Integer

Example: “598528”


orderID

Description: Unique number assigned to an order

Format: Integer

Example: "40001482"


externalOrderID

Description: External order id passed in from a head in system on order creation

Format: String

Example: "Test_AG_448_1480452433"


shipmentID

Description: Unique number assigned to a shipment

Format: Integer

Example: "14181436"


customerID

Description: Unique number assigned to a customer

Format: Integer

Example: "10237458"


fulfillerTotal

Description: Amount the fulfiller will receive from the return

Format: Decimal (2 places)

Example: "10.00"


customerTotal

Description: Amount the customer will receive from the return

Format: Decimal (2 places)

Example: "10.00"


totalTax

Description: Total tax applied

Format: Decimal (2 places)

Example: "10.00"


returnReductions

Description: Reduction applied to the return

Format: Decimal (2 places)

Example: "10.00"


returnToStoreID

Description: Store ID where the product was returned

Format: Integer

Example: "0001"


returnDate

Description: Date the product was returned

Format: String

Example: "2016-12-05 02:23:58"


ProductOMS Dev: Transactional Logs