Method Name: TransactionCheckIn()


Parameters:

Name
Type
Required
Description
id
guid Yes
This customer id value is provided after successfully creating a new account or by finding an account from an email address FindAccount()
productid
guid
Yes
The product ID can be found in your development partner agreement with Red Rook.
batchid
guid
Yes
The batchid is used to logically group transactions together.  A batch can be unique for each transaction or the same for all transactions.
machineid
string(100)
Yes
A machine name is used to identify which system is submitting the transaction.  This can be very helpful when the reporting solution submits information from multiple systems.  ** Please note that it is possible for transactions in the same batch to be submitted from different machines.
transactionid
string(100)
Yes
The transaction id is used to identify the transaction uniquely.
transactionSubtotal
decimal
Yes
The transaction sub-total is the line item total before taxes and miscellaneous fees.
transactionTotal
decimal
Yes
The transaction total is the final amount including line item total, taxes and all other fees.
transactionLineQty
decimal
Yes
This is the # of line items on the transaction.  This is not the quantity of the items.  For instance, a transaction with qty 3 of widget 1 and qty 5 of widget 2 has two (2) line items.  The value submitted here is 2.
transactionItemQuantity
decimal
Yes
This is the total quantity of all items on the transaction being submitted.  In the above example, the value submitted here is 8.
transactionDate
datetime Yes
The UTC date of the transaction.  Acceptable Format: [2008-03-09T16:05:07]


URL: 

https://registration.theredrook.com/TransactionCheckIn/02dfccda-bf32-4d9f-81eb-af4cdd949360?productid=ea15bb16-5171-4b98-9c77-4c503d9040d8&batchid=eb33a266-cf7f-42d9-83e9-2226d7e15445&machineid=Windows%20Name&transactionid=10000190&transactionSubtotal=100.00&transactionTotal=110.00&transactionLineQty=2&transactionItemQuantity=7&transactionDate=01/01/2017


Success Status Code: 200 (Success)

Success response: JSON

{
    "Success": true
}



Error Status Code: 400 (Bad Request)

Error response: JSON

{

    "Error": "A Customer ID is required."

}


{

    "Error": "An invalid Customer ID was requested."

}


{

    "Error": "The requested customer could not be identified."

}


{

    "Error": "A Product ID is required."

}


{

    "Error": "An invalid Product ID was requested."

}


{

    "Error": "The requested product could not be identified."

}


{

    "Error": "A Batch ID is required."

}


{

    "Error": "An invalid Batch ID was requested."

}


{

    "Error": "This customer is not licensed to use this product."

}


{

    "Error": "A transaction ID is required."

}


{

    "Error": "The requested transaction already exists."

}


{

    "Error": "A machine name is required."

}


{

    "Error": "A Transaction Subtotal is required."

}


{

    "Error": "The Transaction Subtotal provided is not valid."

}


{

    "Error": "A Transaction Total is required."

}


{

    "Error": "The Transaction Total provided is not valid."

}


{

    "Error": "A Transaction Line Quantity is required."

}


{

    "Error": "The Transaction Line Quantity provided is not valid."

}


{

    "Error": "A Transaction Item Quantity is required."

}


{

    "Error": "The Transaction Item Quantity provided is not valid."

}


{

    "Error": "A Transaction Date is required."

}


{

    "Error": "The Transaction Date provided is not valid."

}