sales
Description: The comprehensive element of the Sales log
totals
Description: Total sales reported in the log
total
Description: Total sales reported in the log
tender
Description: Sum of all the buy tender by type
Type
Description: Payment type
Format: String
Example: “CS”
Amount
Description: Total amount
Format: Decimal (2 places)
Example: “10.00”
Count
Description: Number of captures
Format: Decimal (2 places)
Example: “10.00”
currencyType
Description: International Standards Organization Code
Format: Currency Code
Example: USD
records
Description: Number of sales
Format: Integer (non-negative)
Example: “10”
salesTotal
Description: Total number of captures
Format: Decimal (2 places)
Example: “100.00”
totalTax
Description: Total number of tax
Format: Decimal (2 places)
Example: “100.00”
uniqueStoresCount
Description: Number of unique stores
Format: Integer (non-negative)
Example: “10”
itemCount
Description: Total number of line items
Format: Integer
Example: “10”
itemQuantityCount
Description: Sum of all the quantity of all the line items
Format: Integer (non-negative)
Example: “100”
sale
Description: A sale element for an order
transferOrder
Description: An optional element for a transfer order
childOrderID
Description: The ID of the child order of the transfer
Format: Integer
Example: “111”
customData
Description: Optional custom data that can be provided for the order
name
Description: The name of the custom data
Format: String
Example: “dwUUID”
value
Description: The value of the custom data
Format: String
Example: “32f1fc2ef78852a0056be1a50b”
billing
Description: Billing information for the order
address
Description: The billing address of the customer
address1
Description: The first line of the street address
Format: String
Example: “127 Alexander Ave”
address2
Description: The second line of the street address (optional)
Format: String
Example: “#323”
address3
Description: The third line of the street address (optional)
Format: String
Example: “#456”
city
Description: The city name of the billing address
Format: String
Example: “Lake Grove”
countryCode
Description: The country for the billing address
Format: String
Example: “US”
state
Description: The state for the billing address
Format: String
Example: “NY”
zip
Description: The zip code of the street address
Format: String
Example: “012345”
phone
Description: The phone number of the customer contact (optional)
Format: String
Example: “555-555-5555”
payment
Description: The payment information for the order
transaction
Description: The transaction details of the purchase
type
Description: Type of the transaction that occurred
Format: Transaction Type
Example: “CREDIT,” “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”
type
Description: Payment Type
Format: String
Example: “CS”
subType
Description: Payment subtype
Format: String
Example: “VI”
cardNumber
Description: 6/4 mask of the credit card used for credit card tender types (optional)
Format: String
Example: “111111XXXXXX1111”
expiration
Description: The optional expiration date of the card.
Format: String
Example: “01_2017”
firstName
Description: Billing first name
Format: String
Example: “janedoe@email.com”
lastName
Description: Billing last name
Format: String
Example: “Doe”
email
Description: Billing email
Format: String
Example: “janedoe@email.com”
shipping
Description: The shipping details of the order
address
Description: The shipping address for the order
address1
Description: The first line of the street address
Format: String
Example: “127 Alexander Ave”
address2
Description: The second line of the street address(optional)
Format: String
Example: “#323”
address3
Description: The third lien of the street address(optional)
Format: String
Example: “456”
city
Description: The city name of the shipping address
Format: String
Example: “Lake Grove”
countryCode
Description: The country for the shipping address
Format: String
Example: “US”
state
Description: The state for the shipping address
Format: String
Example: “NY”
zip
Description: The zip code for the shipping address
Format: String
Example: “012345”
phone
Description: The phone number for the shipping contact (optional)
Format: String
Example: “555-555-5555”
label
Description: The shipping label for the order
carrier
Description: Shipment carrier
Format: String
Example: “UPS”
shippingType
Description: The type of shipping provided by the carrier(optional)
Format: String
Example: “UPS_NEXT_DAY_AIR”
trackingNumber
Description: Unique number assigned to the package by the carrier
Format: String
Example: “Z199999999999”
transitTime
Description: Estimated time of arrival for the shipment
Format: String
Example: “3-5 days”
firstName
Description: Shipping addressee first name
Format: String
Example: “Jane”
lastName
Description: Shipping addressee last name (optional)
Format: String
Example: “Doe”
email
Description: Shipping addressee email (optional)
Format: String
Example: “janedoe@email.com”
message
Description: A message to be included with the shipment (optional)
Format: String
Example: “This is a gift to you.”
item
Description: The item details of the order
unit
Description: The details of an item unit in the order
serialNumber
Description: Serial number for the product
Format: String
Example: “12345”
customData
Description: Optional custom data for the item
name
Description: The name of the custom data
Format: String
Example: “dwUUID”
value
Description: The value of the custom data
Format: String
Example: “32f1fc2ef78852a0056be1a50b”
itemID
Description: Unique number assigned to the item
Format: Integer
Example: “25675930”
partNumber
Description: Unique ID assigned to an item(Optional)
Format: String
Example: “006-94100-02-0”
UPC
Description: Unique number assigned to an item. Typically 12 digits (optional)
Format: String
Example: “657107883144”
SKU
Description: Internal unique number assigned to a product (optional)
Format: String
Example: “V8192D4R”
productName
Description: Name assigned to a product (Optional)
Format: String
Example: “Test_Product”
quantity
Description: Number purchased
Format: Integer
Example: “100”
retailPrice
Description: The retail price or original price of the product
Format: Decimal (2 places)
Example: “10.00”
actualPrice
Description: The actual price of the item paid by the customer
Format: Decimal (2 places)
Example: “10.00”
fulfillerTotal
Description: The value the fulfiller will receive
Format: Decimal
Example: “10.00”
customerTotal
Description: Total paid by the customer
Format: Decimal (2 places)
Example: “10.00”
tax
Description: Tax applied to the item
Format: Decimal (2 places)
Example: “10.00”
shippingTax
Description: Tax applied to shipping cost (Optional)
Format: Decimal (2 places)
Example: “10.00”
orderID
Description: A unique number assigned to an order
Format: Integer
Example: “40001482”
externalOrderID
Description: External order id passed in from a head in system on order creation
Format: String
Example: “Test_AG_448_1480452433”
customOrderNumber
Description: An optional custom order number
Format: String
Example: “01010101”
shipmentID
Description: Unique number assigned to a shipment
Format: Integer
Example: “14181436”
customerID
Description: Unique number assigned to a customer
Format: Integer
Example: “10237458”
storeID
Description: Unique store identification
Format: String
Example: “0001”
orderDate
Description: Date the order was placed
Format: String (date-time)
Example: “2017-05-15T00:15:57+00:00”
shipDate
Description: Date the order was shipped
Format: String (date-time)
Example: “2016-05-15T08:00:00+00:00”
fulfillerTotal
Description: Amount the retailer made on the transaction
Format: Decimal (2 places)
Example: “10.00”
customerTotal
Description: Total the customer paid
Format: Decimal (2 places)
Example: “10.00”
shippingFee
Description: Sum of all fees paid for shipping
Format: Decimal (2 places)
Example: “10.00”
totalTax
Description: Sum of the tax paid
Format: Decimal (2 places)
Example: “10.00”
currencyType
Description: Currency code in ISO 4217
Format: Currency Code
Example: USD
giftOrder
Description: Denotes if the order was a gift order
Format: Boolean
Example: True, False
orderType
Description: Denotes the type of order, see list of value options
Format: Order Type
Example: “STANDARD”