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)
- For example, in the command line this may look like
- 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”
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”
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:
<xs:schema
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:impl="kibo.ucp.tlog.v5.sales"
targetNamespace="kibo.ucp.tlog.v5.sales"
elementFormDefault="qualified">
<xs:element name="sales">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:totals"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:sale"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="totals">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:total"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="total">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="tender">
<xs:annotation>
<xs:documentation>Sum of all the buy tender by type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute use="required" name="paymentType" type="xs:string"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="count" type="impl:decimal_2fd"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute use="required" name="currencyCode">
<xs:simpleType>
<xs:union memberTypes="impl:currencyCode impl:emptyString"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="required" name="records" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Number of sales.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="salesTotal" type="impl:decimal_2fd">
<xs:annotation>
<xs:documentation>Sales amount.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="taxTotal" type="impl:decimal_2fd">
<xs:annotation>
<xs:documentation>Total Tax Amount.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="uniqueLocationsCount" type="xs:nonNegativeInteger"/>
<xs:attribute use="required" name="itemCount" type="xs:integer">
<xs:annotation>
<xs:documentation>Total number of line items.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="itemQuantityCount" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Sum of the all the quantity of all the line items.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="sale">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transferShipment"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:billing"/>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:shipping"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:item"/>
</xs:sequence>
<xs:attribute use="required" name="orderNumber" type="xs:integer"/>
<xs:attribute use="required" name="externalOrderId" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
External order id passed in from a head in system on order creation.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="shipmentNumber" type="xs:integer"/>
<xs:attribute use="required" name="customerAccountId" type="xs:integer"/>
<xs:attribute use="required" name="fulfillmentLocationCode" type="xs:string"/>
<xs:attribute use="required" name="submittedDate" type="xs:dateTime"/>
<xs:attribute use="required" name="fulfillmentDate" type="xs:dateTime"/>
<xs:attribute use="required" name="total" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="shippingTotal" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="taxTotal" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="currencyCode" type="impl:currencyCode"/>
<xs:attribute use="required" name="giftOrder" type="xs:boolean"/>
<xs:attribute use="required" name="shipmentType" type="impl:shipmentType"/>
</xs:complexType>
</xs:element>
<xs:element name="shipping">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:label"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="optional" name="lastName" type="xs:string"/>
<xs:attribute use="optional" name="email" type="xs:string"/>
<xs:attribute use="optional" name="message" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="label">
<xs:complexType>
<xs:attribute name="carrier" type="xs:string"/>
<xs:attribute name="shippingType" type="xs:string"/>
<xs:attribute name="trackingNumber" type="xs:string"/>
<xs:attribute name="shippingMethodName" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="billing">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:payment"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="required" name="lastName" type="xs:string"/>
<xs:attribute use="required" name="email" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="payment">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transaction"/>
</xs:sequence>
<xs:attribute use="required" name="paymentType" type="xs:string"/>
<xs:attribute use="required" name="paymentOrCardType" type="xs:string"/>
<xs:attribute use="optional" name="cardNumber">
<xs:annotation>
<xs:documentation>
6/4 mask of the credit card used for credit card tender types 6-6-4.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="optional" name="expiration" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="transaction">
<xs:complexType>
<xs:attribute use="required" name="type" type="impl:transactionType"/>
<xs:attribute use="optional" name="transactionId" type="xs:string"/>
<xs:attribute use="required" name="transactionDate" type="xs:dateTime"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="transactionStatus" type="impl:transactionStatus"/>
</xs:complexType>
</xs:element>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:unit"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
</xs:sequence>
<xs:attribute use="required" name="lineId" type="xs:integer"/>
<xs:attribute use="optional" name="productCode" type="xs:string"/>
<xs:attribute use="optional" name="variationProductCode" type="xs:string"/>
<xs:attribute use="optional" name="partNumber" type="xs:string"/>
<xs:attribute use="optional" name="UPC" type="xs:string"/>
<xs:attribute use="optional" name="SKU" type="xs:string"/>
<xs:attribute use="optional" name="productName" type="xs:string"/>
<xs:attribute use="required" name="quantity" type="xs:integer"/>
<xs:attribute use="required" name="retailPrice" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="actualPrice" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="total" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="tax" type="impl:decimal_2fd"/>
<xs:attribute use="optional" name="shippingTax" type="impl:decimal_2fd"/>
</xs:complexType>
</xs:element>
<xs:element name="unit">
<xs:complexType>
<xs:attribute use="required" name="serialNumber" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="data">
<xs:complexType>
<xs:attribute use="optional" name="name" type="xs:string"/>
<xs:attribute use="optional" name="value" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="transferShipment">
<xs:complexType>
<xs:attribute use="optional" name="childShipmentNumber" type="xs:integer"/>
</xs:complexType>
</xs:element>
<xs:element name="address">
<xs:complexType>
<xs:attribute use="required" name="address1" type="xs:string"/>
<xs:attribute use="optional" name="address2" type="xs:string"/>
<xs:attribute use="optional" name="address3" type="xs:string"/>
<xs:attribute use="required" name="city" type="xs:string"/>
<xs:attribute use="required" name="countryCode" type="xs:string"/>
<xs:attribute use="required" name="state" type="xs:string"/>
<xs:attribute use="required" name="zip" type="xs:string"/>
<xs:attribute use="optional" name="phone" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="decimal_2fd">
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="currencyCode">
<xs:annotation>
<xs:documentation>
ISO 4217: Currency codes are composed of a country's two-character Internet country code plus a third character denoting the currency unit.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="[A-Z]{3}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="emptyString">
<xs:restriction base="xs:string">
<xs:length value="0"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="AUTHORIZATION" />
<xs:enumeration value="CAPTURE" />
<xs:enumeration value="CREDIT" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="shipmentType">
<xs:restriction base="xs:string">
<xs:enumeration value="STH" />
<xs:enumeration value="BOPIS" />
<xs:enumeration value="Transfer" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transactionStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Success" />
<xs:enumeration value="Failed" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
<?xml version="1.0" encoding="UTF-8"?>
<sales xsi:schemaLocation="../TLogSales.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="kibo.ucp.tlog.v5.sales">
<totals>
<total taxTotal="5.23" itemQuantityCount="15" itemCount="15" uniqueLocationsCount="4" salesTotal="191.77" records="5" currencyCode="USD">
<tender count="3" amount="159.03" paymentType="No_Operation"/>
<tender count="2" amount="55.00" paymentType="CreditCard"/>
</total>
</totals>
<sale taxTotal="0.89" currencyCode="USD" shipmentType="BOPIS" giftOrder="true" shippingTotal="0.00" total="10.79" fulfillmentDate="2020-07-25T23:24:14+00:00" submittedDate="2020-06-30T06:32:01+00:00" fulfillmentLocationCode="10200048" customerAccountId="14669550" shipmentNumber="19970576" externalOrderId="1101715066" orderNumber="21303884">
<transferShipment childShipmentNumber="21303886"/>
<data value="6597104" name="customName1"/>
<data value="SG" name="customName2"/>
<data value="20170714" name="customName3"/>
<billing email="test@yahoo.com" lastName="User" firstName="Marayah">
<address phone="555-555-3611" countryCode="US" zip="94587" state="" city="Union City" address3="" address2="" address1="32213 Horatio Court 3"/>
<payment paymentType="Other" expiration="" cardNumber="O-0V**XXXXXX2248" paymentOrCardType="No_Operation">
<transaction amount="10.79" transactionDate="2020-06-30T06:32:06-07:00" transactionId="N/A" type="CAPTURE" transactionStatus="Success"/>
<transaction amount="10.79" transactionDate="2020-07-26T19:23:27-07:00" transactionId="1" type="CREDIT" transactionStatus="Success"/>
</payment>
</billing>
<shipping email="test@yahoo.com" lastName="User" firstName="Marayah" message="">
<address phone="555-555-3611" countryCode="US" zip="95035" state="CA" city="Milpitas" address3="" address2="" address1="447 Great Mall Drive, Space 700A"/>
</shipping>
<item total="9.90" shippingTax="0.00" tax="0.89" actualPrice="9.90" retailPrice="9.90" productName="MEN UTGP (NINTENDO) SHORT-SLEEVE GRAPHIC T-SHIRT" quantity="1" productCode="194477COL00SMB002000" SKU="" UPC="194477COL00SMB002000" partNumber="194477COL00SMB002000" lineId="1">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_00_194477?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
</sale>
<sale taxTotal="0.00" currencyCode="USD" shipmentType="BOPIS" giftOrder="true" shippingTotal="0.00" total="14.90" fulfillmentDate="2020-07-25T23:22:45+00:00" submittedDate="2020-06-28T03:08:50+00:00" fulfillmentLocationCode="10200071" customerAccountId="14680798" shipmentNumber="19900754" externalOrderId="1101708010" orderNumber="21238400">
<transferShipment childShipmentNumber="21238406"/>
<data value="6585314" name="PFSOrderNumber"/>
<data value="SG" name="PFSOrderType"/>
<data value="20170712" name="PICKUPDATE"/>
<billing email="test@gmail.com" lastName="User" firstName="Taylor">
<address phone="7815588837" countryCode="US" zip="02026" state="" city="DEDHAM" address3="" address2="" address1="83 BEECH ST"/>
<payment paymentType="Other" expiration="" cardNumber="4479**XXXXXX6701" paymentOrCardType="No_Operation">
<transaction amount="14.90" transactionDate="2020-06-28T03:08:55-07:00" transactionId="N/A" type="CAPTURE" transactionStatus="Success"/>
</payment>
</billing>
<shipping email="test@gmail.com" lastName="User" firstName="Taylor" message="">
<address phone="1-555-555-4756" countryCode="US" zip="02026" state="MA" city="Dedham" address3="" address2="" address1="950 Providence Hwy"/>
</shipping>
<item total="14.90" shippingTax="0.00" tax="0.00" actualPrice="14.90" retailPrice="14.90" productName="DISNEY COLLECTION SLIPPERS" quantity="1" productCode="184804COL03SMA004000" SKU="" UPC="184804COL03SMA004000" partNumber="184804COL03SMA004000" lineId="2">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_03_184804?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
</sale>
<sale taxTotal="4.34" currencyCode="USD" shipmentType="BOPIS" giftOrder="true" shippingTotal="0.00" total="133.34" fulfillmentDate="2020-07-25T23:23:49+00:00" submittedDate="2020-06-28T17:54:11+00:00" fulfillmentLocationCode="10200071" customerAccountId="14055086" shipmentNumber="19921294" externalOrderId="1101709672" orderNumber="21254978">
<transferShipment childShipmentNumber="21254994"/>
<data value="6587723" name="PFSOrderNumber"/>
<data value="SG" name="PFSOrderType"/>
<data value="20170712" name="PICKUPDATE"/>
<billing email="test@aol.com" lastName="User" firstName="cindy">
<address phone="7814442941" countryCode="US" zip="02026" state="" city="DEDHAM" address3="" address2="" address1="75 WILLARD ST"/>
<payment paymentType="Other" expiration="" cardNumber="6011**XXXXXX5896" paymentOrCardType="No_Operation">
<transaction amount="133.34" transactionDate="2020-06-28T17:54:17-07:00" transactionId="N/A" type="CAPTURE" transactionStatus="Success"/>
</payment>
</billing>
<shipping email="test@aol.com" lastName="User" firstName="cindy" message="">
<address phone="1-555-555-4756" countryCode="US" zip="02026" state="MA" city="Dedham" address3="" address2="" address1="950 Providence Hwy"/>
</shipping>
<item total="9.90" shippingTax="0.00" tax="0.00" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON TANK TOP" quantity="1" productCode="182220COL00SMA005000" SKU="" UPC="182220COL00SMA005000" partNumber="182220COL00SMA005000" lineId="1">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_00_182220?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="9.90" shippingTax="0.00" tax="0.00" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON TANK TOP" quantity="1" productCode="182220COL09SMA005000" SKU="" UPC="182220COL09SMA005000" partNumber="182220COL09SMA005000" lineId="2">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_09_182220?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="9.90" shippingTax="0.00" tax="0.00" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" productCode="189885COL00SMA005000" SKU="" UPC="189885COL00SMA005000" partNumber="189885COL00SMA005000" lineId="3">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_00_189885?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="9.90" shippingTax="0.00" tax="0.00" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" productCode="189885COL69SMA005000" SKU="" UPC="189885COL69SMA005000" partNumber="189885COL69SMA005000" lineId="4">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_69_189885?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="9.90" shippingTax="0.00" tax="0.00" actualPrice="9.90" retailPrice="9.90" productName="WOMEN MODAL LINEN V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" productCode="193083COL00SMA005000" SKU="" UPC="193083COL00SMA005000" partNumber="193083COL00SMA005000" lineId="5">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_00_193083?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="9.90" shippingTax="0.00" tax="0.00" actualPrice="9.90" retailPrice="9.90" productName="WOMEN MODAL LINEN V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" productCode="193083COL69SMA005000" SKU="" UPC="193083COL69SMA005000" partNumber="193083COL69SMA005000" lineId="6">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_69_193083?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="14.90" shippingTax="0.00" tax="0.93" actualPrice="14.90" retailPrice="14.90" productName="WOMEN MERCERIZED COTTON FLARE SHORT-SLEEVE T-SHIRT" quantity="1" productCode="400173COL09SMA005000" SKU="" UPC="400173COL09SMA005000" partNumber="400173COL09SMA005000" lineId="7">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_09_400173?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="14.90" shippingTax="0.00" tax="0.93" actualPrice="14.90" retailPrice="14.90" productName="WOMEN MERCERIZED COTTON FLARE SHORT-SLEEVE T-SHIRT" quantity="1" productCode="400173COL58SMA005000" SKU="" UPC="400173COL58SMA005000" partNumber="400173COL58SMA005000" lineId="8">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_58_400173?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="19.90" shippingTax="0.00" tax="1.24" actualPrice="19.90" retailPrice="19.90" productName="WOMEN DRAPE V-NECK SLEEVELESS BLOUSE" quantity="1" productCode="401919COL09SMB005000" SKU="" UPC="401919COL09SMB005000" partNumber="401919COL09SMB005000" lineId="9">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_09_401919?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="19.90" shippingTax="0.00" tax="1.24" actualPrice="19.90" retailPrice="19.90" productName="WOMEN DRAPE V-NECK SLEEVELESS BLOUSE" quantity="1" productCode="401919COL17SMB005000" SKU="" UPC="401919COL17SMB005000" partNumber="401919COL17SMB005000" lineId="10">
<data value="//CLIENT.scene7.com/is/image/CLIENT/goods_17_401919?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item total="0.00" shippingTax="0.00" tax="0.00" actualPrice="0.00" retailPrice="0.00" productName="FREEZER BAG (14 in x 18 in)" quantity="1" productCode="406882COL99SIZ999000" SKU="" UPC="406882COL99SIZ999000" partNumber="406882COL99SIZ999000" lineId="11">
<data value="//CLIENT.scene7.com/is/image/CLIENT/01_ToteBags-COMP2_R2_v2" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
</sale>
<sale taxTotal="0.00" currencyCode="USD" shipmentType="STH" giftOrder="false" shippingTotal="0.00" total="30.00" fulfillmentDate="2020-07-26T19:13:37+00:00" submittedDate="2020-07-26T19:11:04+00:00" fulfillmentLocationCode="OHL" customerAccountId="14783068" shipmentNumber="20056566" externalOrderId="Test_KT_917_1501096263" orderNumber="40002332">
<data value="test" name="test code"/>
<billing email="Test.test@kibocommerce.com" lastName="User" firstName="Test">
<address phone="555-555-5557" countryCode="US" zip="93405" state="" city="San Luis Obispo" address3="" address2="" address1="123 San Luis Obispo Ln."/>
<payment paymentType="CreditCard" expiration="08_2019" cardNumber="411111XXXXXX1111" paymentOrCardType="Visa">
<transaction amount="30.00" transactionDate="2020-07-26T19:13:55-07:00" transactionId="912571079339" type="CAPTURE" transactionStatus="Success"/>
<transaction amount="1.00" transactionDate="2020-07-26T19:15:12-07:00" transactionId="912571079339" type="CREDIT" transactionStatus="Success"/>
<transaction amount="2.00" transactionDate="2020-07-26T19:15:42-07:00" transactionId="912571079339" type="CREDIT" transactionStatus="Success"/>
<transaction amount="27.00" transactionDate="2020-07-26T19:18:16-07:00" transactionId="912571079339" type="CREDIT" transactionStatus="Success"/>
</payment>
</billing>
<shipping email="" lastName="User" firstName="Test" message="">
<address phone="555-555-5135" countryCode="US" zip="93401" state="CA" city="San Luis Obispo" address3="" address2="" address1="505 Brizzolara St #5"/>
</shipping>
<item total="30.00" shippingTax="0.00" tax="0.00" actualPrice="30.00" retailPrice="40.00" productName="Hi, this is an order." quantity="1" productCode="Product0001" SKU="" UPC="Product0001" partNumber="Product0001" lineId="1">
<data value="Custom Data Value 001" name="Custom Data Key 2"/>
<data value="Custom Data Value 002" name="Custom Data Key 3"/>
<data value="Custom Data Value 003" name="Custom Data Key 1"/>
</item>
</sale>
<sale taxTotal="0.00" currencyCode="USD" shipmentType="STH" giftOrder="false" shippingTotal="0.00" total="30.00" fulfillmentDate="2020-07-26T19:12:22+00:00" submittedDate="2020-07-26T19:10:22+00:00" fulfillmentLocationCode="STANDARD" customerAccountId="14783068" shipmentNumber="20056564" externalOrderId="Test_KT_455_1501096218" orderNumber="40002330">
<data value="test" name="test code"/>
<billing email="Test.test@kibocommerce.com" lastName="User" firstName="Test">
<address phone="555-555-5557" countryCode="US" zip="93405" state="" city="San Luis Obispo" address3="" address2="" address1="123 San Luis Obispo Ln."/>
<payment paymentType="CreditCard" expiration="08_2019" cardNumber="411111XXXXXX1111" paymentOrCardType="Visa">
<transaction amount="30.00" transactionDate="2020-07-26T19:13:15-07:00" transactionId="912571079339" type="CAPTURE" transactionStatus="Success"/>
<transaction amount="5.00" transactionDate="2020-07-26T19:19:53-07:00" transactionId="912571079339" type="CREDIT" transactionStatus="Success"/>
</payment>
</billing>
<shipping email="" lastName="User" firstName="Test" message="">
<address phone="555-555-5135" countryCode="US" zip="93401" state="CA" city="San Luis Obispo" address3="" address2="" address1="505 Brizzolara St #5"/>
</shipping>
<item total="30.00" shippingTax="0.00" tax="0.00" actualPrice="30.00" retailPrice="40.00" productName="Hi, this is an order." quantity="1" productCode="Product0001" SKU="" UPC="Product0001" partNumber="Product0001" lineId="1">
<data value="Custom Data Value 001" name="Custom Data Key 2"/>
<data value="Custom Data Value 002" name="Custom Data Key 3"/>
<data value="Custom Data Value 003" name="Custom Data Key 1"/>
</item>
</sale>
</sales>
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”
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”
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
<xs:schema
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:impl="kibo.ucp.tlog.v5.transfers"
targetNamespace="kibo.ucp.tlog.v5.transfers"
elementFormDefault="qualified">
<xs:element name="transfers">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:totals"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transfer"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="totals">
<xs:complexType>
<xs:attribute use="required" name="shipmentCount" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Number of shipments.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="orderCount" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Number of orders.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="itemCount" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Number of items.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="itemQuantityCount" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Number of quantity of items.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="transfer">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:billing"/>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:shipping"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:item"/>
</xs:sequence>
<xs:attribute use="required" name="orderNumber" type="xs:integer"/>
<xs:attribute use="required" name="externalOrderId" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
External order id passed in from a head in system on order creation.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="parentShipmentNumber" type="xs:string"/>
<xs:attribute use="required" name="status" type="impl:transferStatus"/>
<xs:attribute use="required" name="shipmentNumber" type="xs:integer"/>
<xs:attribute use="optional" name="locationCode" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
The external store for the location that shipped the item.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="receivedDate" type="xs:dateTime"/>
<xs:attribute use="required" name="shipmentType" type="impl:shipmentType"/>
</xs:complexType>
</xs:element>
<xs:element name="billing">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:payment"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="required" name="lastName" type="xs:string"/>
<xs:attribute use="required" name="email" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="payment">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transaction"/>
</xs:sequence>
<xs:attribute use="required" name="paymentType" type="xs:string"/>
<xs:attribute use="required" name="paymentOrCardType" type="xs:string"/>
<xs:attribute use="optional" name="cardNumber">
<xs:annotation>
<xs:documentation>
6/4 mask of the credit card used for credit card tender types 6-6-4.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="optional" name="expiration" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="transaction">
<xs:complexType>
<xs:attribute use="required" name="type" type="impl:transactionType"/>
<xs:attribute use="required" name="transactionId" type="xs:string"/>
<xs:attribute use="required" name="transactionDate" type="xs:string"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="optional" name="transactionStatus" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="shipping">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:label"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="optional" name="lastName" type="xs:string"/>
<xs:attribute use="optional" name="email" type="xs:string"/>
<xs:attribute use="optional" name="locationCode" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
The external store that received the item (the parent shipment).
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="label">
<xs:complexType>
<xs:attribute use="required" name="carrier" type="xs:string"/>
<xs:attribute use="optional" name="shippingType" type="xs:string"/>
<xs:attribute use="required" name="trackingNumber" type="xs:string"/>
<xs:attribute use="optional" name="shippingMethodName" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
</xs:sequence>
<xs:attribute use="required" name="lineId" type="xs:integer"/>
<xs:attribute use="optional" name="partNumber" type="xs:string"/>
<xs:attribute use="optional" name="UPC" type="xs:string"/>
<xs:attribute use="optional" name="SKU" type="xs:string"/>
<xs:attribute use="optional" name="productCode" type="xs:string"/>
<xs:attribute use="optional" name="productVariationCode" type="xs:string"/>
<xs:attribute use="optional" name="productName" type="xs:string"/>
<xs:attribute use="required" name="quantity" type="xs:integer"/>
<xs:attribute use="required" name="retailPrice" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="actualPrice" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="total" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="tax" type="impl:decimal_2fd"/>
<xs:attribute use="optional" name="shippingTax" type="impl:decimal_2fd"/>
</xs:complexType>
</xs:element>
<xs:element name="data">
<xs:complexType>
<xs:attribute use="optional" name="name" type="xs:string"/>
<xs:attribute use="optional" name="value" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="address">
<xs:complexType>
<xs:attribute use="required" name="address1" type="xs:string"/>
<xs:attribute use="optional" name="address2" type="xs:string"/>
<xs:attribute use="optional" name="address3" type="xs:string"/>
<xs:attribute use="required" name="city" type="xs:string"/>
<xs:attribute use="required" name="countryCode" type="xs:string"/>
<xs:attribute use="optional" name="state" type="xs:string"/>
<xs:attribute use="optional" name="zip" type="xs:string"/>
<xs:attribute use="optional" name="phone" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="decimal_2fd">
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transferStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="RECEIVED" />
<xs:enumeration value="UNUSABLE" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="AUTHORIZATION" />
<xs:enumeration value="CAPTURE" />
<xs:enumeration value="CREDIT" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="shipmentType">
<xs:restriction base="xs:string">
<xs:enumeration value="STH" />
<xs:enumeration value="BOPIS" />
<xs:enumeration value="Transfer" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
<?xml version="1.0" encoding="UTF-8"?>
<transfers xsi:schemaLocation="../TLogTransfers.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="kibo.ucp.tlog.v5.transfers">
<totals itemQuantityCount="13" itemCount="13" orderCount="3" shipmentCount="3"/>
<transfer shipmentType="TRANSFER" receivedDate="2017-07-02T02:10:27+00:00" locationCode="OHL" shipmentNumber="19900756" status="RECEIVED" parentShipmentNumber="21238400" externalOrderId="UNU01708010_149861933126" orderNumber="21238406">
<data value="6585314" name="PFSOrderNumber"/>
<data value="SG" name="PFSOrderType"/>
<data value="20170712" name="PICKUPDATE"/>
<billing email="WeCare@MAIL.Client-usa.aom" lastName="SOHO" firstName="John">
<address phone="7815588837" countryCode="US" zip="02026" state="" city="DEDHAM" address3="" address2="" address1="83 BEECH ST"/>
<payment expiration="" cardNumber="111111XXXXXX1111" paymentOrCardType="No_Operation" paymentType="Other">
<transaction amount="14.90" transactionDate="2017-06-28T03:08:54-07:00" transactionId="N/A" type="CAPTURE"/>
</payment>
</billing>
<shipping locationCode="10200071" email="" lastName="SOHO" firstName="John">
<address phone="877-486-4756" countryCode="US" zip="02026" state="MA" city="Dedham" address3="" address2="" address1="950 Providence Hwy "/>
</shipping>
<item shippingTax="0.00" tax="0.00" total="14.90" actualPrice="14.90" retailPrice="14.90" productName="DISNEY COLLECTION SLIPPERS" quantity="1" SKU="" productCode="184804COL03SMA004000" UPC="184804COL03SMA004000" partNumber="184804COL03SMA004000" lineId="38460244">
<data value="//Client.scene7.com/is/image/Client/goods_03_184804?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
</transfer>
<transfer shipmentType="TRANSFER" receivedDate="2017-07-02T02:10:49+00:00" locationCode="OHL" shipmentNumber="19921300" status="RECEIVED" parentShipmentNumber="21254978" externalOrderId="UNU01709672_149867245231" orderNumber="21254994">
<data value="6587723" name="PFSOrderNumber"/>
<data value="SG" name="PFSOrderType"/>
<data value="20170712" name="PICKUPDATE"/>
<billing email="WeCare@MAIL.Client-usa.aom" lastName="SOHO" firstName="John">
<address phone="7814442941" countryCode="US" zip="02026" state="" city="DEDHAM" address3="" address2="" address1="75 WILLARD ST"/>
<payment expiration="" cardNumber="111111XXXXXX1111" paymentOrCardType="No_Operation" paymentType="Other">
<transaction amount="129.00" transactionDate="2017-06-28T17:54:15-07:00" transactionId="N/A" type="CAPTURE"/>
</payment>
</billing>
<shipping locationCode="10200071" email="" lastName="SOHO" firstName="John">
<address phone="877-486-4756" countryCode="US" zip="02026" state="MA" city="Dedham" address3="" address2="" address1="950 Providence Hwy "/>
</shipping>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON TANK TOP" quantity="1" SKU="" productCode="182220COL00SMA005000" UPC="182220COL00SMA005000" partNumber="182220COL00SMA005000" lineId="38504778">
<data value="//Client.scene7.com/is/image/Client/goods_00_182220?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON TANK TOP" quantity="1" SKU="" productCode="182220COL09SMA005000" UPC="182220COL09SMA005000" partNumber="182220COL09SMA005000" lineId="38504780">
<data value="//Client.scene7.com/is/image/Client/goods_09_182220?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" SKU="" productCode="189885COL00SMA005000" UPC="189885COL00SMA005000" partNumber="189885COL00SMA005000" lineId="38504774">
<data value="//Client.scene7.com/is/image/Client/goods_00_189885?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="WOMEN Supima COTTON V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" SKU="" productCode="189885COL69SMA005000" UPC="189885COL69SMA005000" partNumber="189885COL69SMA005000" lineId="38504776">
<data value="//Client.scene7.com/is/image/Client/goods_69_189885?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="WOMEN MODAL LINEN V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" SKU="" productCode="193083COL00SMA005000" UPC="193083COL00SMA005000" partNumber="193083COL00SMA005000" lineId="38504782">
<data value="//Client.scene7.com/is/image/Client/goods_00_193083?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="WOMEN MODAL LINEN V-NECK SHORT-SLEEVE T-SHIRT" quantity="1" SKU="" productCode="193083COL69SMA005000" UPC="193083COL69SMA005000" partNumber="193083COL69SMA005000" lineId="38504784">
<data value="//Client.scene7.com/is/image/Client/goods_69_193083?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="14.90" actualPrice="14.90" retailPrice="14.90" productName="WOMEN MERCERIZED COTTON FLARE SHORT-SLEEVE T-SHIRT" quantity="1" SKU="" productCode="400173COL09SMA005000" UPC="400173COL09SMA005000" partNumber="400173COL09SMA005000" lineId="38504788">
<data value="//Client.scene7.com/is/image/Client/goods_09_400173?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="14.90" actualPrice="14.90" retailPrice="14.90" productName="WOMEN MERCERIZED COTTON FLARE SHORT-SLEEVE T-SHIRT" quantity="1" SKU="" productCode="400173COL58SMA005000" UPC="400173COL58SMA005000" partNumber="400173COL58SMA005000" lineId="38504790">
<data value="//Client.scene7.com/is/image/Client/goods_58_400173?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="19.90" actualPrice="19.90" retailPrice="19.90" productName="WOMEN DRAPE V-NECK SLEEVELESS BLOUSE" quantity="1" SKU="" productCode="401919COL09SMB005000" UPC="401919COL09SMB005000" partNumber="401919COL09SMB005000" lineId="38504792">
<data value="//Client.scene7.com/is/image/Client/goods_09_401919?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="19.90" actualPrice="19.90" retailPrice="19.90" productName="WOMEN DRAPE V-NECK SLEEVELESS BLOUSE" quantity="1" SKU="" productCode="401919COL17SMB005000" UPC="401919COL17SMB005000" partNumber="401919COL17SMB005000" lineId="38504794">
<data value="//Client.scene7.com/is/image/Client/goods_17_401919?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
<item shippingTax="0.00" tax="0.00" total="0.00" actualPrice="0.00" retailPrice="0.00" productName="FREEZER BAG (14 in x 18 in)" quantity="1" SKU="" productCode="406882COL99SIZ999000" UPC="406882COL99SIZ999000" partNumber="406882COL99SIZ999000" lineId="38504786">
<data value="//Client.scene7.com/is/image/Client/01_ToteBags-COMP2_R2_v2" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
</transfer>
<transfer shipmentType="TRANSFER" receivedDate="2017-07-02T06:12:46+00:00" locationCode="OHL" shipmentNumber="19970578" status="RECEIVED" parentShipmentNumber="21303884" externalOrderId="UNU01715066_149880432264" orderNumber="21303886">
<data value="6597104" name="PFSOrderNumber"/>
<data value="SG" name="PFSOrderType"/>
<data value="20170714" name="PICKUPDATE"/>
<billing email="WeCare@MAIL.Client-usa.aom" lastName="SOHO" firstName="John">
<address phone="510-612-3611" countryCode="US" zip="94587" state="" city="Union City" address3="" address2="" address1="32213 Horatio Court 3"/>
<payment expiration="" cardNumber="111111XXXXXX1111" paymentOrCardType="No_Operation" paymentType="Other">
<transaction amount="9.90" transactionDate="2017-06-30T06:32:05-07:00" transactionId="N/A" type="CAPTURE"/>
</payment>
</billing>
<shipping locationCode="10200048" email="" lastName="SOHO" firstName="John">
<address phone="877-486-4756" countryCode="US" zip="95035" state="CA" city="Milpitas" address3="" address2="" address1="447 Great Mall Drive, Space 700A "/>
</shipping>
<item shippingTax="0.00" tax="0.00" total="9.90" actualPrice="9.90" retailPrice="9.90" productName="MEN UTGP (NINTENDO) SHORT-SLEEVE GRAPHIC T-SHIRT" quantity="1" SKU="" productCode="194477COL00SMB002000" UPC="194477COL00SMB002000" partNumber="194477COL00SMB002000" lineId="38635046">
<data value="//Client.scene7.com/is/image/Client/goods_00_194477?$prod$" name="image_url"/>
<data value="true" name="SDCLICK"/>
</item>
</transfer>
</transfers>
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”
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
<xs:schema
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:impl="kibo.ucp.tlog.v5.credits"
targetNamespace="kibo.ucp.tlog.v5.credits"
elementFormDefault="qualified">
<xs:element name="credits">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:totals"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:order"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="totals">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:total"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="total">
<xs:complexType>
<xs:attribute use="required" name="currencyCode">
<xs:simpleType>
<xs:union memberTypes="impl:currencyCode impl:emptyString"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="required" name="credits" type="xs:nonNegativeInteger"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="orders" type="xs:nonNegativeInteger"/>
</xs:complexType>
</xs:element>
<xs:element name="order">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:customer"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:billing"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:credit"/>
</xs:sequence>
<xs:attribute use="required" name="orderNumber" type="xs:integer"/>
<xs:attribute use="required" name="externalOrderId" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="billing">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:payment"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="required" name="lastName" type="xs:string"/>
<xs:attribute use="required" name="email" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="address">
<xs:complexType>
<xs:attribute use="required" name="address1" type="xs:string"/>
<xs:attribute use="optional" name="address2" type="xs:string"/>
<xs:attribute use="optional" name="address3" type="xs:string"/>
<xs:attribute use="required" name="city" type="xs:string"/>
<xs:attribute use="required" name="countryCode" type="xs:string"/>
<xs:attribute use="required" name="state" type="xs:string"/>
<xs:attribute use="required" name="zip" type="xs:string"/>
<xs:attribute use="optional" name="phone" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="payment">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transaction"/>
</xs:sequence>
<xs:attribute use="required" name="paymentType" type="xs:string"/>
<xs:attribute use="required" name="paymentOrCardType" type="xs:string"/>
<xs:attribute use="optional" name="cardNumber">
<xs:annotation>
<xs:documentation>
6/4 mask of the credit card used for credit card tender types 6-6-4.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="optional" name="expiration" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="transaction">
<xs:complexType>
<xs:attribute use="required" name="type" type="impl:transactionType"/>
<xs:attribute use="optional" name="transactionId" type="xs:string"/>
<xs:attribute use="required" name="transactionDate" type="xs:string"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="optional" name="transactionStatus" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="customer">
<xs:complexType>
<xs:attribute use="required" name="customerAccountId" type="xs:nonNegativeInteger"/>
<xs:attribute use="optional" name="firstName" type="xs:string"/>
<xs:attribute use="optional" name="lastName" type="xs:string"/>
<xs:attribute use="required" name="email" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="credit">
<xs:complexType>
<xs:attribute use="required" name="currencyCode" type="impl:currencyCode"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="creditDate" type="xs:dateTime"/>
<xs:attribute use="optional" name="notes" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="data">
<xs:complexType>
<xs:attribute use="required" name="name" type="xs:string"/>
<xs:attribute use="required" name="value" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="decimal_2fd">
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="currencyCode">
<xs:annotation>
<xs:documentation>
ISO 4217: Currency codes are composed of a country's two-character Internet country code plus a third character denoting the currency unit.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="[A-Z]{3}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="emptyString">
<xs:restriction base="xs:string">
<xs:length value="0"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="AUTHORIZATION" />
<xs:enumeration value="CAPTURE" />
<xs:enumeration value="CREDIT" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
CREDITS TLOG EXAMPLE:
<?xml version="1.0" encoding="UTF-8"?>
<credits xsi:schemaLocation="../TLogCredits.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="kibo.ucp.tlog.v5.credits">
<totals>
<total orders="2" amount="8.00" credits="3" currencyCode="USD"/>
</totals>
<order externalOrderId="AB12345" orderNumber="40002330">
<customer email="Test.User@kibocommerce.com" lastName="User" firstName="Test" customerAccountId="14783068"/>
<data value="test" name="test code"/>
<billing email="Test.User@kibocommerce.com" lastName="User" firstName="Test">
<address phone="469-466-5557" countryCode="US" zip="93405" state="" city="San Luis Obispo" address3="" address2="" address1="123 San Luis Obispo Ln."/>
<payment expiration="08_2019" cardNumber="************1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="30.00" transactionDate="2017-07-26T19:13:15-07:00" transactionId="912571079339" type="CAPTURE"/>
<transaction amount="5.00" transactionDate="2017-07-26T19:19:53-07:00" transactionId="912571079339" type="CREDIT"/>
</payment>
</billing>
<credit amount="5.00" currencyCode="USD" notes="Issues fulfilling the order, refunding the customer" creditDate="2017-07-26T19:19:21-07:00"/>
</order>
<order externalOrderId="AB12356" orderNumber="40002332">
<customer email="Test.User@kibocommerce.com" lastName="User" firstName="Test" customerAccountId="14783068"/>
<data value="test" name="test code"/>
<billing email="Test.User@kibocommerce.com" lastName="User" firstName="Test">
<address phone="469-466-5557" countryCode="US" zip="93405" state="" city="San Luis Obispo" address3="" address2="" address1="123 San Luis Obispo Ln."/>
<payment expiration="08_2019" cardNumber="************1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="30.00" transactionDate="2017-07-26T19:13:55-07:00" transactionId="912571079339" type="CAPTURE"/>
<transaction amount="1.00" transactionDate="2017-07-26T19:15:12-07:00" transactionId="912571079339" type="CREDIT"/>
<transaction amount="2.00" transactionDate="2017-07-26T19:15:42-07:00" transactionId="912571079339" type="CREDIT"/>
<transaction amount="27.00" transactionDate="2017-07-26T19:18:16-07:00" transactionId="912571079339" type="CREDIT"/>
</payment>
</billing>
<credit amount="1.00" currencyCode="USD" notes="Refunding the customer shipping" creditDate="2017-07-26T19:14:52-07:00"/>
<credit amount="2.00" currencyCode="USD" notes="Product arrived late" creditDate="2017-07-26T19:15:35-07:00"/>
</order>
</credits>
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”
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
<xs:schema
elementFormDefault="qualified"
targetNamespace="kibo.ucp.tlog.v5.cancels"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:impl="kibo.ucp.tlog.v5.cancels">
<xs:element name="cancels">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:totals" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:cancel" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="totals">
<xs:complexType>
<xs:attribute type="xs:integer" name="orderCount"/>
<xs:attribute type="xs:integer" name="itemCount"/>
<xs:attribute type="xs:integer" name="itemQuantityCount"/>
</xs:complexType>
</xs:element>
<xs:element name="cancel">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data" />
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:billing"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:item" />
</xs:sequence>
<xs:attribute type="xs:integer" name="orderNumber"/>
<xs:attribute type="xs:string" name="externalOrderId"/>
<xs:attribute type="xs:integer" name="customerAccountId"/>
<xs:attribute type="xs:dateTime" name="submittedDate"/>
<xs:attribute type="xs:dateTime" name="cancelDate"/>
<xs:attribute type="xs:decimal" name="cancelTotal"/>
<xs:attribute use="required" name="shipmentType" type="impl:shipmentType"/>
</xs:complexType>
</xs:element>
<xs:element name="billing">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:payment"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="required" name="lastName" type="xs:string"/>
<xs:attribute use="required" name="email" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="address">
<xs:complexType>
<xs:attribute use="required" name="address1" type="xs:string"/>
<xs:attribute use="optional" name="address2" type="xs:string"/>
<xs:attribute use="optional" name="address3" type="xs:string"/>
<xs:attribute use="required" name="city" type="xs:string"/>
<xs:attribute use="required" name="countryCode" type="xs:string"/>
<xs:attribute use="required" name="state" type="xs:string"/>
<xs:attribute use="required" name="zip" type="xs:string"/>
<xs:attribute use="optional" name="phone" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="payment">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transaction"/>
</xs:sequence>
<xs:attribute use="required" name="paymentType" type="xs:string"/>
<xs:attribute use="required" name="paymentOrCardType" type="xs:string"/>
<xs:attribute use="optional" name="cardNumber">
<xs:annotation>
<xs:documentation>
6/4 mask of the credit card used for credit card tender types 6-6-4.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="optional" name="expiration" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="transaction">
<xs:complexType>
<xs:attribute use="required" name="type" type="impl:transactionType"/>
<xs:attribute use="optional" name="transactionId" type="xs:string"/>
<xs:attribute use="required" name="transactionDate" type="xs:string"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="optional" name="transactionStatus" type="impl:transactionStatus"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="decimal_2fd">
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data" />
</xs:sequence>
<xs:attribute use="required" type="xs:integer" name="lineId"/>
<xs:attribute use="optional" type="xs:integer" name="shipmentNumber"/>
<xs:attribute type="xs:string" name="productName"/>
<xs:attribute type="xs:string" name="partNumber"/>
<xs:attribute type="xs:string" name="UPC"/>
<xs:attribute type="xs:string" name="SKU"/>
<xs:attribute type="xs:string" name="productCode"/>
<xs:attribute type="xs:string" name="productVariationCode"/>
<xs:attribute type="xs:integer" name="quantity"/>
<xs:attribute type="xs:decimal" name="total"/>
<xs:attribute type="xs:integer" name="reasonCode"/>
<xs:attribute type="xs:string" name="reason"/>
</xs:complexType>
</xs:element>
<xs:element name="data">
<xs:complexType>
<xs:attribute type="xs:string" name="name"/>
<xs:attribute type="xs:string" name="value"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="transactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="CAPTURE" />
<xs:enumeration value="CREDIT" />
<xs:enumeration value="AUTHORIZATION" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="shipmentType">
<xs:restriction base="xs:string">
<xs:enumeration value="STH" />
<xs:enumeration value="BOPIS" />
<xs:enumeration value="Transfer" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transactionStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Success" />
<xs:enumeration value="Failed" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
CANCELS TLOG EXAMPLE:
<?xml version="1.0" encoding="UTF-8"?>
<cancels xsi:schemaLocation="../TLogCancels.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="kibo.ucp.tlog.v5.cancels">
<totals itemQuantityCount="19" itemCount="12" orderCount="5"/>
<cancel cancelTotal="39.99" cancelDate="2016-09-22T16:44:31-07:00" submittedDate="2016-09-20T21:34:08-07:00" customerAccountId="10237458" orderNumber="15200304">
<data value="3009917796504009~3009917796504017~3009917796504025~3009917796504033~3009917796504041~300991779650405" name="bbCouponCodes"/>
<billing email="sgolden@lyonscg.com" lastName="testing" firstName="sandra">
<address phone="333-333-3333" countryCode="US" zip="35235" state="" city="Birmingham" address3="" address2="" address1="BHM Address Line 1"/>
<payment expiration="01_2017" cardNumber="411111XXXXXX1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="207.30" transactionDate="2016-09-20T21:34:09-07:00" transactionId="15200304133195808212" type="CREDIT"/>
</payment>
</billing>
<item reason="Other" reasonCode="81" total="39.99" quantity="1" SKU="" UPC="657107821757" partNumber="006-90298-97-M" productName="3/4 Sleeve Babydoll Maternity Sweater" shipmentNumber="0" lineId="24706382">
<data value="50185a775a52381477a9bb2468" name="dwUUId"/>
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
</item>
</cancel>
<cancel cancelTotal="69.54" cancelDate="2016-09-22T17:04:24-07:00" submittedDate="2016-09-22T17:01:54-07:00" customerAccountId="10237458" orderNumber="15347326">
<data value="3009917798260006~3009917798260014~3009917798260022~3009917798260030~3009917798260048" name="bbCouponCodes"/>
<billing email="sgolden@lyonscg.com" lastName="testing" firstName="sandra">
<address phone="333-333-3333" countryCode="US" zip="35235" state="" city="Birmingham" address3="" address2="" address1="BHM Address Line 1"/>
<payment expiration="01_2017" cardNumber="411111XXXXXX1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="69.54" transactionDate="2016-09-22T17:01:55-07:00" transactionId="4745636205156890204010" type="CAPTURE"/>
<transaction amount="69.54" transactionDate="2016-09-22T17:01:56-07:00" transactionId="15347326134662061946" type="CREDIT"/>
</payment>
</billing>
<item reason="Other" reasonCode="81" total="34.77" quantity="1" SKU="" UPC="657107845883" partNumber="006-91477-01-L" productName="3/4 Sleeve Crochet Detail Maternity Dress" shipmentNumber="13929640" lineId="24996142" productCode="657107845883">
<data value="9bd750548ca7ac8f735af58e08" name="dwUUId"/>
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
</item>
<item reason="Other" reasonCode="81" total="34.77" quantity="1" SKU="" UPC="657107842769" partNumber="006-90250-91-M" productName="Sleeveless Tye Dye Maternity Maxi Dress" shipmentNumber="13929640" lineId="24996140" productCode="657107842769">
<data value="0d32965f4c4171ed34e5e0c504" name="dwUUId"/>
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
</item>
</cancel>
<cancel cancelTotal="5.00" cancelDate="2016-10-10T17:03:14-07:00" submittedDate="2016-10-10T16:35:45-07:00" customerAccountId="11184648" orderNumber="15660780">
<billing email="harriet.lue@testorder.aom" lastName="Lue" firstName="Harriet">
<address phone="111-222-3333" countryCode="US" zip="93405" state="" city="San Luis Obispo" address3="" address2="" address1="123 San Luis Obispo Ln."/>
<payment expiration="02_2018" cardNumber="444433XXXXXX1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="11.00" transactionDate="2016-10-10T16:35:48-07:00" transactionId="912571079339" type="CAPTURE"/>
<transaction amount="11.00" transactionDate="2016-10-10T16:37:52-07:00" transactionId="912571079339" type="CREDIT"/>
</payment>
</billing>
<item reason="Other" reasonCode="81" total="5.00" quantity="1" SKU="" UPC="009209139962R" partNumber="00062-99-0_REPLACEMENT" productName="Replacement Item for #1" shipmentNumber="14109330" lineId="25573500" productCode="009209139962R">
<data value="http://mysticsports.com/product/img/123.jpg" name="image_url"/>
</item>
</cancel>
<cancel cancelTotal="5.00" cancelDate="2016-10-10T23:33:07-07:00" submittedDate="2016-10-10T23:28:34-07:00" customerAccountId="10038460" orderNumber="15666626">
<billing email="dionne.white@kibocommerce.com" lastName="Smith" firstName="Josephine">
<address phone="111-222-3333" countryCode="US" zip="93405" state="" city="San Luis Obispo" address3="" address2="" address1="123 San Luis Obispo Ln."/>
<payment expiration="02_2018" cardNumber="444433XXXXXX1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="11.00" transactionDate="2016-10-10T23:28:36-07:00" transactionId="912571079339" type="CAPTURE"/>
<transaction amount="11.00" transactionDate="2016-10-10T23:29:28-07:00" transactionId="912571079339" type="CREDIT"/>
</payment>
</billing>
<item reason="Other" reasonCode="81" total="5.00" quantity="1" SKU="" UPC="009209139962" partNumber="00062-99-0" productName="Original Item #1" shipmentNumber="14119854" lineId="25583538" productCode="009209139962"/>
</cancel>
<cancel cancelTotal="252.43" cancelDate="2016-09-29T18:02:50-07:00" submittedDate="2016-07-19T07:31:13-07:00" customerAccountId="10237458" orderNumber="14436986">
<data value="zTestPromotionOrder,TESTORDER" name="dwOrderLevelPromoIds"/>
<billing email="sgolden@lyonscg.com" lastName="testing" firstName="sandra">
<address phone="333-333-3333" countryCode="US" zip="35235" state="" city="Birmingham" address3="" address2="" address1="BHM Address Line 1"/>
<payment expiration="07_2016" cardNumber="411111XXXXXX1111" paymentOrCardType="Visa" paymentType="CreditCard">
<transaction amount="252.43" transactionDate="2016-07-19T07:31:15-07:00" transactionId="4688797383756943101018" type="CAPTURE"/>
<transaction amount="252.43" transactionDate="2016-07-19T07:31:15-07:00" transactionId="14436986125609702429" type="CREDIT"/>
</payment>
</billing>
<item reason="Order created by mistake" reasonCode="2" total="65.92" quantity="3" SKU="" UPC="006-90138-98-L" partNumber="006-90138-98-L" productName="3/4 Sleeve Babydoll Maternity Sweater" shipmentNumber="13929514" lineId="23392716" productCode="006-90138-98-L">
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
<data value="zTestPromotionProduct,TESTPRODUCT|zTestBogo,BOGO" name="dwLineLevelPromoIds"/>
</item>
<item reason="Order created by mistake" reasonCode="2" total="0.00" quantity="1" SKU="" UPC="006-90138-32-L" partNumber="006-90138-32-L" productName="3/4 Sleeve Babydoll Maternity Sweater" shipmentNumber="13929514" lineId="23392718" productCode="006-90138-32-L">
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
<data value="zTestBonusProduct" name="dwLineLevelPromoIds"/>
</item>
<item reason="Order created by mistake" reasonCode="2" total="0.00" quantity="1" SKU="" UPC="000" partNumber="000" productName="Extended Warranty: 000" shipmentNumber="13929514" lineId="23392720"/>
<item reason="Order created by mistake" reasonCode="2" total="22.18" quantity="1" SKU="" UPC="006-90138-97-XL" partNumber="006-90138-97-XL" productName="3/4 Sleeve Babydoll Maternity Sweater" shipmentNumber="13929514" lineId="23392722" productCode="006-90138-97-XL">
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
<data value="zTestPromotionProduct,TESTPRODUCT|zTestBogo,BOGO" name="dwLineLevelPromoIds"/>
</item>
<item reason="Order created by mistake" reasonCode="2" total="144.26" quantity="6" SKU="" UPC="006-90138-97-XL" partNumber="006-90138-97-XL" productName="3/4 Sleeve Babydoll Maternity Sweater" shipmentNumber="13929514" lineId="23392724" productCode="006-90138-97-XL">
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
<data value="zTestPromotionProduct,TESTPRODUCT|zTestBogo,BOGO" name="dwLineLevelPromoIds"/>
</item>
<item reason="Order created by mistake" reasonCode="2" total="15.93" quantity="1" SKU="" UPC="006-90138-32-L" partNumber="006-90138-32-L" productName="3/4 Sleeve Babydoll Maternity Sweater" shipmentNumber="13929514" lineId="23392726" productCode="006-90138-32-L">
<data value="Mystic Sports" name="brand"/>
<data value="http://mysticsports.com/product/img/123.jpg" name="img_url"/>
<data value="zTestPromotionProduct,TESTPRODUCT" name="dwLineLevelPromoIds"/>
</item>
<item reason="Order created by mistake" reasonCode="2" total="4.14" quantity="1" SKU="" UPC="001" partNumber="001" productName="Extended Warranty: 001" shipmentNumber="13929514" lineId="23392728" productCode="001"/>
</cancel>
</cancels>
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”
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
<xs:schema
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:impl="kibo.ucp.tlog.v5.returns"
targetNamespace="kibo.ucp.tlog.v5.returns"
elementFormDefault="qualified">
<xs:element name="returns">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:totals"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:return"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="totals">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:total"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="total">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="tender">
<xs:annotation>
<xs:documentation>Sum of all the buy tender by type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute use="required" name="type" type="xs:string"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="required" name="count" type="impl:decimal_2fd"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute use="required" name="currencyCode">
<xs:simpleType>
<xs:union memberTypes="impl:currencyCode impl:emptyString"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="required" name="records" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Number of sales.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="total" type="impl:decimal_2fd">
<xs:annotation>
<xs:documentation>Total customer returns amount.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="uniqueLocationsCount" type="xs:nonNegativeInteger"/>
<xs:attribute use="required" name="itemCount" type="xs:integer">
<xs:annotation>
<xs:documentation>Total number of line items.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="required" name="itemQuantityCount" type="xs:nonNegativeInteger">
<xs:annotation>
<xs:documentation>Sum of the all the quantity of all the line items.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="return">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:billing"/>
<xs:element maxOccurs="unbounded" ref="impl:item"/>
</xs:sequence>
<xs:attribute name="returnId" type="xs:string"/>
<xs:attribute name="orderNumber" type="xs:integer"/>
<xs:attribute name="externalOrderId" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
External order id passed in from a head in system on order creation.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute use="optional" name="customOrderNumber" type="xs:string"/>
<xs:attribute name="shipmentNumber" type="xs:integer"/>
<xs:attribute name="customerAccountId" type="xs:integer"/>
<xs:attribute name="total" type="impl:decimal_2fd"/>
<xs:attribute name="totalTax" type="impl:decimal_2fd"/>
<xs:attribute name="returnReduction" type="impl:decimal_2fd"/>
<xs:attribute name="returnToStoreId" type="xs:string"/>
<xs:attribute name="returnDate" type="xs:string"/>
<xs:attribute name="currencyCode">
<xs:simpleType>
<xs:union memberTypes="impl:currencyCode impl:emptyString"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="required" name="shipmentType" type="impl:shipmentType"/>
</xs:complexType>
</xs:element>
<xs:element name="billing">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" ref="impl:address"/>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="impl:payment"/>
</xs:sequence>
<xs:attribute use="required" name="firstName" type="xs:string"/>
<xs:attribute use="required" name="lastName" type="xs:string"/>
<xs:attribute use="required" name="email" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="address">
<xs:complexType>
<xs:attribute use="required" name="address1" type="xs:string"/>
<xs:attribute use="optional" name="address2" type="xs:string"/>
<xs:attribute use="optional" name="address3" type="xs:string"/>
<xs:attribute use="required" name="city" type="xs:string"/>
<xs:attribute use="required" name="countryCode" type="xs:string"/>
<xs:attribute use="required" name="state" type="xs:string"/>
<xs:attribute use="required" name="zip" type="xs:string"/>
<xs:attribute use="optional" name="phone" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="payment">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:transaction"/>
</xs:sequence>
<xs:attribute use="required" name="paymentType" type="xs:string"/>
<xs:attribute use="required" name="paymentOrCardType" type="xs:string"/>
<xs:attribute use="optional" name="cardNumber">
<xs:annotation>
<xs:documentation>
6/4 mask of the credit card used for credit card tender types 6-6-4.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute use="optional" name="expiration" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="transaction">
<xs:complexType>
<xs:attribute use="required" name="type" type="impl:transactionType"/>
<xs:attribute use="optional" name="transactionId" type="xs:string"/>
<xs:attribute use="required" name="transactionDate" type="xs:string"/>
<xs:attribute use="required" name="amount" type="impl:decimal_2fd"/>
<xs:attribute use="optional" name="transactionStatus" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:unit"/>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="impl:data"/>
</xs:sequence>
<xs:attribute name="itemId" type="xs:integer"/>
<xs:attribute name="partNumber" type="xs:string"/>
<xs:attribute name="UPC" type="xs:string"/>
<xs:attribute name="SKU" type="xs:string"/>
<xs:attribute name="productCode" type="xs:string"/>
<xs:attribute name="productVariationCode" type="xs:string"/>
<xs:attribute name="returnReason" type="xs:string"/>
<xs:attribute name="quantity" type="xs:integer"/>
<xs:attribute name="actualPrice" type="impl:decimal_2fd"/>
<xs:attribute name="customerSubtotal" type="impl:decimal_2fd"/>
<xs:attribute name="returnItemTaxTotal" type="impl:decimal_2fd"/>
</xs:complexType>
</xs:element>
<xs:element name="unit">
<xs:complexType>
<xs:attribute use="required" name="serialNumber" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="data">
<xs:complexType>
<xs:attribute use="required" name="name" type="xs:string"/>
<xs:attribute use="required" name="value" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:simpleType name="decimal_2fd">
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="currencyCode">
<xs:annotation>
<xs:documentation>
ISO 4217: Currency codes are composed of a country's two-character Internet country code plus a third character denoting the currency unit.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="[A-Z]{3}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="emptyString">
<xs:restriction base="xs:string">
<xs:length value="0"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="transactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="CAPTURE" />
<xs:enumeration value="CREDIT" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="shipmentType">
<xs:restriction base="xs:string">
<xs:enumeration value="STH" />
<xs:enumeration value="BOPIS" />
<xs:enumeration value="Transfer" />
</xs:restriction>
</xs:simpleType>
</xs:schema
RETURNS TLOG EXAMPLE:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<returns>
<totals>
<total currencyCode="USD" records="10" total="176.73" uniqueLocationsCount="2" itemCount="15" itemQuantityCount="33"/>
</totals>
<return returnId="183" orderNumber="3967" externalOrderId="" shipmentNumber="5571" customerAccountId="1003" total="35.22" totalTax="0.00" returnReduction="0.00" returnToStoreId="BGG" returnDate="2024-03-26T07:35:57-04:00" currencyCode="USD" shipmentType="STH">
<billing firstName="Example" lastName="Customer" email="example.customer@kibocommerce.com">
<address address1="1234 Example Drive" city="Irvine" countryCode="US" state="CA" zip="92664" phone="1-999-111-2222"/>
<payment paymentType="CreditCard" paymentOrCardType="VISA" cardNumber="************1111" expiration="01_2028">
<transaction type="AUTHORIZATION" transactionId="123456789abcdefg" transactionDate="2024-03-26T06:16:02-04:00" amount="64.38" transactionStatus="Success"/>
<transaction type="CAPTURE" transactionId="987654321gfedcba" transactionDate="2024-03-26T06:16:28-04:00" amount="64.38" transactionStatus="Success"/>
<transaction type="CREDIT" transactionId="123abc456def789ghi" transactionDate="2024-03-26T07:35:53-04:00" amount="35.22" transactionStatus="Success"/>
</payment>
</billing>
<item itemId="1" quantity="6" returnReason="Damaged" actualPrice="5.99" customerSubtotal="35.22" returnItemTaxTotal="0.00" UPC="CH01"/>
</return>
<return returnId="187" orderNumber="3970" externalOrderId="" shipmentNumber="5574" customerAccountId="1003" total="5.87" totalTax="0.00" returnReduction="0.00" returnToStoreId="BGG" returnDate="2024-03-26T10:43:21-04:00" currencyCode="USD" shipmentType="STH">
<billing firstName="Example" lastName="Customer" email="example.customer@kibocommerce.com">
<address address1="1234 Example Drive" city="Irvine" countryCode="US" state="CA" zip="92664" phone="1-949-307-5762"/>
<payment paymentType="CreditCard" paymentOrCardType="VISA" cardNumber="************1111" expiration="01_2028">
<transaction type="AUTHORIZATION" transactionId="jsdlkfjsi3288r0r" transactionDate="2024-03-26T09:46:35-04:00" amount="43.42" transactionStatus="Success"/>
<transaction type="CAPTURE" transactionId="b839hfhkfa088y23fnlds" transactionDate="2024-03-26T10:08:46-04:00" amount="43.42" transactionStatus="Success"/>
<transaction type="CREDIT" transactionId="293894ur4dssfb792" transactionDate="2024-03-26T10:43:18-04:00" amount="5.87" transactionStatus="Success"/>
</payment>
</billing>
<item itemId="1" quantity="1" returnReason="Damaged" actualPrice="5.99" customerSubtotal="5.87" returnItemTaxTotal="0.00" UPC="CH01"/>
</return>
<return returnId="188" orderNumber="3971" externalOrderId="" shipmentNumber="5575" customerAccountId="1003" total="17.08" totalTax="1.34" returnReduction="0.00" returnToStoreId="BGG" returnDate="2024-03-26T10:46:52-04:00" currencyCode="USD" shipmentType="BOPIS">
<billing firstName="Example" lastName="Customer" email="example.customer@kibocommerce.com">
<address address1="1234 Example Drive" city="Irvine" countryCode="US" state="CA" zip="92664" phone="1-949-307-5762"/>
<payment paymentType="CreditCard" paymentOrCardType="VISA" cardNumber="************1111" expiration="01_2028">
<transaction type="AUTHORIZATION" transactionId="sdlkf2323js949032" transactionDate="2024-03-26T10:45:14-04:00" amount="17.08" transactionStatus="Success"/>
<transaction type="CAPTURE" transactionId="010108384hdsf348h8h8" transactionDate="2024-03-26T10:45:20-04:00" amount="17.08" transactionStatus="Success"/>
<transaction type="CREDIT" transactionId="43k9580j2nd0282her284" transactionDate="2024-03-26T10:46:51-04:00" amount="17.08" transactionStatus="Success"/>
</payment>
</billing>
<item itemId="2" quantity="2" returnReason="Other" actualPrice="2.00" customerSubtotal="4.34" returnItemTaxTotal="0.34" UPC="CH02"/>
<item itemId="1" quantity="2" returnReason="Damaged" actualPrice="5.99" customerSubtotal="12.74" returnItemTaxTotal="1.00" UPC="CH01"/>
</return>
</returns>