Skip to main content
The Kibo Composable Commerce Platform makes Transactional Logs (TLogs) available to clients as an accounting tool intended for reconciliation purposes. Five TLogs are sent: Sales, Transfers, Credits, Cancels, and Returns. These reports include information regarding the specifics of each order captured, including payment type. Kibo recommends setting up a daily TLog to capture data for the entire day at once, instead of multiple logs throughout the day. This should be run after all fulfillment centers are done fulfilling for the day, if possible. This is because there is a delay before data is accessible to the TLog for reporting. For example, if a shipment is fulfilled at 9:30 then it may not be present on a report that runs at 10:00 because it didn’t have time to be ingested. Running a single TLog later in the day reduces the chance of data being excluded from the expected report.

​
SFTP Best Practices

If you are using a client-side or third-party SFTP droppoint to receive transactional logs, Kibo recommends following the below guidelines to maximize performance.
  • Ensuring access to the SFTP droppoint is the responsibility of the client or third party maintainer. Make sure that Kibo’s SFTP user has read and write permissions to the directory, which is required to deliver files.
    • For example, in the command line this may look like drw-rw-r-- (which means the owner has read/write, the group has read/write, others are read-only)
  • Ensure files do not pile up over time → utilize /archive folders and periodic cleanup of historic data. Monitor the droppoint and clean up files that are no longer needed.
    • If you need to retain the files, archive them to another folder once they’ve been processed.
  • Ensure disk space usage is monitored and alerts the maintaining IT team in time to address low disk space situations before causing connection issues for Kibo.

​
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 shipment and include order, shipping, billing, and item information. In addition to accounting uses, the Sales TLog can be used to communicate order and shipment data to in-house distribution centers. The shipment has to be fulfilled to show up on the Sales TLog. There is an optional block in the case of transfer shipments, in which the child shipment number will be provided. The details of the child shipment are compiled in the Transfers TLog, while the shipment listed in the Sales TLog is the parent shipment (the BOPIS, or pickup, shipment that requested the transfer). Below are the descriptions of all data elements returned in the log, though the .xsd master schema is also provided below.

​
Sales

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 paymentType 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” currencyCode 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” taxTotal Description: Total number of tax Format: Decimal (2 places) Example: “100.00” uniqueLocationsCount Description: Number of unique locations 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 transferShipment Description: An optional element for a transfer shipment childShipmentNumber Description: The number of the child shipment of the transfer Format: Integer Example: “111” data 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: 2nd 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 transactionType Description: Type of the transaction that occurred Format: Transaction Type Example: CREDIT, “CAPTURE,” or “AUTHORIZE” 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” paymentType Description: Payment Type Format: String Example: “CS” paymentOrCardType Description: Payment subtype Format: String Example: “VI” cardNumber Description: 6/4 mask of the credit card (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: “Jane” 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: 2nd 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” shippingMethodName Description: The shipping method being used Format: String Example: “NAME HERE” firstName Description: Shipping first name Format: String Example: “Jane” lastName Description: Shipping last name Format: String Example: “Doe” email Description: Shipping email 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” data 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” lineId Description: Unique number assigned to the line item Format: Integer Example: “25675930” productCode Description: Unique ID assigned to a product (optional) Format: String Example: “006-94100-02-0” variationProductCode Description: Unique ID assigned to a product variant (optional) Format: String Example: “006-94100-02-0” UPC Description: Unique number assigned to an item (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” total 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” orderNumber Description: A unique number assigned to an order Format: Integer Example: “40001482” externalOrderID Description: External order identifier. Format: String Example: “Test_AG_448_1480452433” shipmentNumber Description: Unique number assigned to a shipment Format: Integer Example: “14181436” customerAccountId Description: Unique number assigned to a customer Format: Integer Example: “10237458” fulfillmentLocationCode Description: Unique location identification Format: String Example: “0001” submittedDate Description: Date the order was placed Format: String (date-time) Example: “2017-05-15T00:15:57+00:00” fulfillmentDate Description: Date the order was fulfilled Format: String (date-time) Example: “2016-05-15T08:00:00+00:00” total Description: Total cost of the item Format: Decimal (2 places) Example: “10.00” shippingTotal Description: Sum of all amounts paid for shipping Format: Decimal (2 places) Example: “10.00” taxTotal Description: Sum of the tax paid Format: Decimal (2 places) Example: “10.00” currencyCode 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 shipmentType Description: Denotes the type of shipment (STH, BOPIS, or TRANSFER) Format: Shipment Type Example: STH SALES TLOG SCHEMA:
SALES TLOG EXAMPLE:

​
Single Calendar Day Transfers Reporting

Transfer (Ship to Store) TLogs define the transfer shipments. These reports have some differences in comparison to the parent shipment’s Sales TLog to specify details such as transfer locations and the date the transfer was received. Below are the descriptions of all data elements returned in the log, though the .xsd master schema is also provided below.

​
Transfers

transfers Description: The comprehensive element of the Transfers log totals Description: Total sales reported in the log shipmentCount Description: Number of shipments Format: Integer (non-negative) Example: “100” orderCount Description: Number of orders Format: Integer (non-negative) Example: “100” itemCount Description: Number of items Format: Integer (non-negative) Example: “100” itemQuantityCount Description: Number of quantity of items Format: Integer (non-negative) Example: “100” transfer Description: A transfer element for an order data 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: 2nd 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 transactionType Description: Type of the transaction that occurred Format: Transaction Type Example: CREDIT, “CAPTURE,” or “AUTHORIZE” 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” paymentType Description: Payment Type Format: String Example: “CS” paymentOrCardType Description: Payment subtype Format: String Example: “VI” cardNumber Description: 6/4 mask of the credit card (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: “Jane” 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: 2nd 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” shippingMethodName Description: The shipping method being used Format: String Example: “NAME HERE” 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” locationCode Description: The external store that received the item (the parent order) Format: String Example: “982784” item Description: The item details of the order data 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” lineId Description: Unique number assigned to the line 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 (optional) Format: String Example: “657107883144” SKU Description: Internal unique number assigned to a product (optional) Format: String Example: “V8192D4R” productCode Description: Code assigned to a product (Optional) Format: String Example: “Test_Product” productVariationCode Description: Code assigned to a product variant (Optional) Format: String Example: “Test_Product” 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” total 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” orderNumber Description: A unique number assigned to an order Format: Integer Example: “40001482” externalOrderID Description: External order id. Format: String Example: “Test_AG_448_1480452433” parentShipmentId Description: The ID of the transfer’s parent shipment Format: String Example: “Test_AG_448_1480452433” status Description: Status of the transfer Format: “RECEIVED” or “UNUSABLE” Example: “14181436” shipmentNumber Description: Unique number assigned to a shipment Format: Integer Example: “14181436″ locationCode Description: The external code for the location that shipped the item Format: String Example: “0001” receivedDate Description: Date the transfer was received Format: String (date-time) Example: “2017-05-15T00:15:57+00:00” shipmentType Description: Denotes the type of shipment (STH, BOPIS, TRANSFER) Format: Shipment Type Example: TRANSFER TRANSFERS TLOG SCHEMA
TRANSFERS TLOG EXAMPLE:

​
Single Calendar Day Credits Reporting

Credits TLogs relay data about credits across all orders occurring on a single calendar day. This report applies to orders in any state, including canceled and fulfilled orders, but only lists goodwill credits. It does not include any refunds made to returns, which are compiled in the Returns Tlogs. Below are the descriptions of all data elements returned in the log, though the .xsd master schema is also provided below.

​
Credits

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 currencyCode Description: International Standards Organization Code Format: Currency Code Example: “USD” credits Description: Number of credits Format: Integer (non-negative) Example: “1” amount Description: Total amount of the credits Format: Decimal (non-negative) Example: “16.99” orders Description: Number of orders Format: Integer (non-negative) Example: “1” order Description: Order details for the credits customer Description: Customer details for the order customer Description: Unique number assigned to a customer Format: Integer (non-negative) Example: “10237458” data 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: 2nd 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 transactionType Description: Transaction type Format: String Example: “CAPTURE” or “CREDIT” transactionId Description: Unique ID 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 for the transaction Format: Decimal (2 places) Example: “10.00” transactionStatus Description: The status of the transaction. Format: String Example: “Success” paymentType Description: Payment type Format: String Example: “CS” paymentOrCardType Description: Payment subtype Format: String Example: “VI” cardNumber Description: 6/4 mask of the credit card (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 currencyCode 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” orderNumber Description: A unique number assigned to an order Format: Integer Example: “40001482” externalOrderID Description: External order id. Format: String Example: “Test_AG_448_1480452433” CREDITS TLOG SCHEMA
CREDITS TLOG EXAMPLE:

​
Single Calendar Day Cancels Reporting

Cancels TLogs relay the order data for all canceled orders occurring on a single calendar day. Below are the descriptions of all data elements returned in the log, though the .xsd master schema is also provided below.

​
Cancels

cancels Description: The comprehensive element of the Cancels log totals Description: Total cancels reported in the log orderCount Description: Total canceled orders reported in the log Format: Integer Example: “1000” itemCount Description: Total items reported in the log Format: Integer Example: “1000” itemQuantityCount Description: Total item quantities reported in the log Format: Integer Example: “1000” cancel Description: A cancel element for an order data 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: 2nd 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 transactionType Description: Type of the transaction that occurred Format: Transaction Type Example: CREDIT, CAPTURE, AUTHORIZE 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” paymentType Description: Payment Type Format: String Example: “CS” paymentOrCardType Description: Payment subtype Format: String Example: “VI” cardNumber Description: 6/4 mask of the credit card (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: “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 data 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” lineId Description: Unique number assigned to the item Format: Integer Example: “25675930” shipmentNumber Description: Unique shipment number of the item (Optional) Format: Integer Example: “25675930” productName Description: Name assigned to a product (Optional) Format: String Example: “Test_Product” partNumber Description: Unique ID assigned to an item (Optional) Format: String Example: “006-94100-02-0” UPC Description: Unique number assigned to an item (optional) Format: String Example: “657107883144” SKU Description: Internal unique number assigned to a product (optional) Format: String Example: “V8192D4R” productCode Description: Internal unique number assigned to a product (optional) Format: String Example: “V8192D4R” productVariationCode Description: Unique number assigned to a product variant (optional) Format: String Example: “V8192D4R” quantity Description: Number purchased Format: Integer Example: “100” total Description: The total price of the product Format: Decimal Example: “10.00” reasonCode Description: A code corresponding to a reason for the cancellation Format: Integer Example: “1” reason Description: The text explanation of the reason code Format: String Example: “Customer changed mind” orderNumber Description: A unique number assigned to an order Format: Integer Example: “40001482” externalOrderId Description: A unique external number assigned to an order Format: Integer Example: “40001482” customerAccountId Description: Unique number assigned to a customer Format: Integer Example: “10237458” submittedDate Description: Date the order was placed Format: String (date-time) Example: “2017-05-15T00:15:57+00:00” cancelDate Description: Date the order was canceled Format: String (date-time) Example: “2017-05-15T00:15:57+00:00” cancelTotal Description: Amount that was canceled Format: Decimal Example: “10.00” CANCELS TLOG SCHEMA
CANCELS TLOG EXAMPLE:

​
Single Calendar Day Returns Reporting

Returns TLogs relay the shipment data for all returned shipments occurring on a single calendar day. Returns that have been refunded will appear on the Returns TLog. Below are the descriptions of all data elements returned in the log, though the .xsd master schema is also provided below.

​
Returns

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” currencyCode Description: International Standards Organization Code Format: Currency Code Example: “USD” records Description: Number of returns Format: Integer (non-negative) Example: “10” total Description: Total customer returns amount Format: Decimal (2 places) Example: “10.00” uniqueLocationsCount 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 data 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: 2nd 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 transactionType Description: Transaction type Format: String Example: “CAPTURE” or “CREDIT” transactionId Description: Unique ID 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 for the transaction Format: Decimal (2 places) Example: “10.00” transactionStatus Description: The status of the transaction. Format: String Example: “Success” type Description: Payment type Format: String Example: “CS” paymentOrCardType Description: Payment subtype Format: String Example: “VI” cardNumber Description: 6/4 mask of the credit card (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” data 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 (optional) Format: String Example: “657107883144” SKU Description: Internal unique number assigned to a product (optional) Format: String Example: “V8192D4R” productCode Description: Internal unique number assigned to a product (optional) Format: String Example: “V8192D4R” productVariationCode Description: Unique number assigned to a product variant (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” customerSubtotal Description: Amount the customer will be reimbursed for the item Format: Decimal (2 places) Example: “10.00” returnItemTaxTotal Description: Amount the customer will be reimbursed for the item tax Format: Decimal (2 places) Example: “3.00” returnId Description: Unique number generated by Kibo Format: Integer Example: “598528” orderNumber Description: Unique number assigned to an order Format: Integer Example: “40001482” externalOrderID Description: External order id. Format: String Example: “Test_AG_448_1480452433” customOrderNumber Description: An optional custom order number Format: String Example: “14181436” shipmentNumber Description: Unique number assigned to a shipment Format: Integer Example: “10237458” customerAccountID Description: Unique number assigned to a customer Format: Integer Example: “10237458” total 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” returnReduction 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” currencyCode Description: International Standards Organization Code Format: Currency Code Example: USD shipmentType Description: Denotes the type of shipment (STH, BOPIS, TRANSFER) Format: Shipment Type Example: “STH” RETURNS TLOG SCHEMA
RETURNS TLOG EXAMPLE: