Web Sale Order Lookup Service

The Web Sale Lookup Service provides endpoints to retrieve sale order details and to update/resend purchase confirmation or eGift emails.

Endpoints

Get Order Details

GET websaleorderlookup/orderDetails.json

Retrieves the details of a specific sale order.

The following authentication methods are allowed for this endpoint:

Query Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID for the merchant where the sale occurred.
  • orderNumber (String) – (required) The order number to retrieve details for.
"result": "success"
jsonparam String result:
 

(required) success
jsonparam Object orderDetails:
 

(required) See OrderDetails for format of the object.

Examples:
{

“result”: “success”, “orderDetails”: {

“billingAddress”: {
“address1”: “123 Example St”, “address2”: “”, “cardHolder”: “Alex Example”, “city”: “Example City”, “country”: “United States”, “email”: “user.one@example.com”, “phone”: “(555) 010-1234”, “postalCode”: “00000”, “state”: “Example State”

}, “orderSummary”: {

“orderDate”: “2025-08-28 21:37:11”, “orderNumber”: “1010”, “orderStatus”: “Completed”, “orderTotal”: “30.00”, “program”: “Web eGift”, “programType”: “EGIFT”, “subtotal”: “30.00”

}, “orderedItems”: [

{
“assignedCardNumbers”: [
“9401210000001111”

], “code”: “egift”, “deliveredDate”: “2025-08-28 20:40:21”, “deliveryStatus”: “COMPLETED”, “itemTotal”: “10.00”, “personalMessage”: {

“from”: “Sender One”, “message”: “Test 1”, “to”: “Recipient One”

}, “quantity”: 1, “recipientEmail”: “user.one@example.com”, “unitPrice”: “10.00”

}, {

“assignedCardNumbers”: [
“9401210000002222”, “9401210000003333”

], “code”: “egift”, “deliveredDate”: “2025-08-28 20:40:24”, “deliveryStatus”: “COMPLETED”, “itemTotal”: “10.00”, “personalMessage”: {

“from”: “Sender Two”, “message”: “Test2”, “to”: “Recipient Two”

}, “quantity”: 2, “recipientEmail”: “user.two@example.com”, “unitPrice”: “10.00”

}

], “paymentDetails”: {

“creditCardType”: “VISA”, “last4Digits”: “0000”, “referenceNumber”: “EXAMPLE-REF-0001”, “status”: “Approved”, “transactionDate”: “2025-08-28 21:37:12”

}

}

}

"result": "failure"
JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure.
  • errorMessage (String) – (required) The (human readable) error message of the failure.

Update and Resend Purchase Email

POST websaleorderlookup/updateAndResendPurchaseEmail.json

Updates the sender email address for the egift order confirmation and resends the purchase email.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID for the merchant where the sale occurred.
  • orderNumber (String) – (required) The order number for which the purchase email should be updated and resent.
  • updatedEmail (String) – (required) The new email address to send the order purchase confirmation email.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
"result": "failure"
JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure.
  • errorMessage (String) – (required) The (human readable) error message of the failure.

Update and Resend eGift Email

POST websaleorderlookup/updateAndResendEgiftEmail.json

Updates the recipient email address for an eGift delivery email and resends it. Either the oldEmail or the cardNumber needs to be provided.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID for the merchant where the sale occurred.
  • orderNumber (String) – (required) The order number for which the eGift email should be updated and resent.
  • updatedEmail (String) – (required) The new email address to send the eGift to.
  • oldEmail (String) – (optional) The recipient’s old email address to update.
  • cardNumber (String) – (optional) The eGift card number to update the recipient email for.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
"result": "failure"
JSON Parameters:
 
  • result (String) – (required) failure
  • errorCode (String) – (required) The error code of the failure.
  • errorMessage (String) – (required) The (human readable) error message of the failure.

Reply Objects

Note

All date/time fields are ISO-8601 strings. LocalDateTime fields are rendered with timezone if available (e.g., 2025-08-12T14:05:31Z). Date fields are rendered as an ISO date (e.g., 2027-12-01).

OrderDetails
JSON Parameters:
 
  • orderSummary (Object) – (required) See OrderSummary.
  • billingAddress (Object) – (required) See BillingAddress.
  • paymentDetails (Object) – (required) See PaymentDetails.
  • orderedItems (List[Object]) – (required) List of items in the order. See OrderedItem.
OrderSummary
JSON Parameters:
 
  • program (String) – (required) The program name
  • programType (String) – (required) Paytronix-assigned code (e.g., EGIFT).
  • orderNumber (String) – (required) The order number.
  • orderDate (DateTime) – (optional) Date/time the order was placed.
  • subtotal (Decimal) – (required) Subtotal before discounts.
  • promotion (String) – (optional) Promotion code applied, if any.
  • discountTotal (Decimal) – (optional) Total discount amount.
  • orderTotal (Decimal) – (required) Final order total.
  • orderStatus (String) – (optional) Current order status.
BillingAddress
JSON Parameters:
 
  • cardHolder (String) – (optional) Cardholder name.
  • address1 (String) – (optional) First line of the address.
  • address2 (String) – (optional) Second line of the address.
  • city (String) – (optional)
  • state (String) – (optional)
  • postalCode (String) – (optional)
  • country (String) – (optional)
  • phone (String) – (optional)
  • email (String) – (optional)
PaymentDetails
JSON Parameters:
 
  • transactionDate (DateTime) – (optional) Transaction date/time.
  • creditCardType (String) – (optional) Card type (e.g., VISA).
  • last4Digits (String) – (optional) Last four digits of the card.
  • expiration (Date) – (optional) Card expiration date.
  • status (String) – (optional) Payment status.
  • referenceNumber (String) – (optional) Reference number.
OrderedItem
JSON Parameters:
 
  • code (String) – (required) The unique code of the item.
  • quantity (Integer) – (required) Quantity purchased.
  • unitPrice (Decimal) – (required) Unit price before discount.
  • discountAmount (Decimal) – (optional) Discount applied to this item.
  • itemTotal (Decimal) – (required) Final total for this line item.
  • personalMessage (String) – (required) See PersonalMessage.
  • recipientEmail (String) – (optional) Recipient email address (e.g., for eGift).
  • requestedDeliveryDate (DateTime) – (optional) Requested delivery date/time.
  • assignedCardNumbers (List[String]) – (required) List of assigned card numbers (masked where appropriate).
  • deliveredDate (DateTime) – (optional) Actual delivery date/time.
  • deliveryStatus (String) – (optional) Delivery status.
PersonalMessage
JSON Parameters:
 
  • from (String) – (optional) The name of the sender of the eGift order.
  • to (String) – (optional) The name of the recipient of the eGift order.
  • message (String) – (optional) The personalized message included in eGift order.

Error Codes

The following are the possible codes and messages that can be returned by the Web Sale Lookup Service.

There may be other system-level errors which are not documented here. The caller can use the returned message directly or map codes to custom UI text.

Code Message
websaleorderlookup.failed_to_locate_cache Failed to locate <cache>
websaleorderlookup.failed_to_retrieve_details Failed to retrieve <details> for order number <orderNumber>
websaleorderlookup.invalid_data Invalid <data> for <orderNumber>
websaleorderlookup.failed_to_update_details Failed to update <details> for order number <orderNumber>
websaleorderlookup.failed_to_send_email Failed to send email to <email> for order number <orderNumber>
websaleorderlookup.server_error Server Error