Skip to main content

Get Order Details

Get the order details.

Post
https://store.payproglobal.com/api/Orders/GetOrderDetails
Request Parametersapplication/json
GetOrderDetailRequestModel
object
orderId
integer
required
The order ID for which you want to get the details.
dateFormat
string
optional
The date format in which you want to get the order details.
Possible values:
a - "yyyy-MM-ddTHH:mm:ss.fff"
b - "M/d/yyyy"
c - "d-MMM-yyyy"
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
GetOrderDetailResponseModel
object
response
object
orderId
integer
The order ID.
orderStatusId
integer
The ID of the order status. Possible values: 1 – Waiting, 2 – Canceled,
3 –Refunded, 4 – Chargeback, 5 – Processed.
orderStatusName
integer
The text representation of the order status.
paymentMethodId
integer
The ID of the payment method you applied.
The list of payment methods can be found here
paymentMethodName
string
The text representation of the payment method.
createdAt
string
The date when order has been placed.
mainProductId
integer
The main product ID used in the order.
billingCurrencyCode
string
The order billing currency code.
balanceCurrencyCode
string
The order balance currency code.
customer
object
The customer's data.
customerId
integer
The integer customer ID.
firstName
string
The customer's first name.
lastName
string
The customer's last name.
companyName
string
The customer's company name.
email
string
The customer's email address.
phone
string
The customer's phone number.
country
string
The customer's country name.
state
string
The customer's state name.
city
string
The customer's city.
address
string
The customer's address.
zipCode
string
The customer's zip/postal code.
streetNumber
string
The customer's street number. It is only available if the customer's
chosen billing country is Mexico, Brazil, Chile
taxNumber
string
The customer's tax number.
fiscalNumberPersonal
string
The customer's personal fiscal number. Available if the billing country is Brazil.
fiscalNumberCorporate
string
The customer's corporate fiscal number. Available if the billing country is Brazil.
payPalAccount
string
The customer's PayPal account if used.
affiliateIds
array[integer]
The list of the affiliates' IDs if the order was affiliated.
orderItems
array[object]
The details of the order items associated with this order.
orderItemId
integer
The integer order item ID.
productId
integer
The product ID of the order item.
orderId
integer
The order ID of the order item.
vendorAccountId
integer
The order item vendor account ID.
orderItemName
string
The product name of the order item.
quantity
integer
The product quantity in the order item.
billingPrice
number
The actual order item price (all units minus all discounts) in a billing currency.
appliedDiscountCouponCode
string
The coupon code that have been applied to the order item.
dateCreated
string
The date when the order item has been created.
orderItemTypeId
integer
The order item type ID. Possible values: 1-Product, 2-BackupMedia,
3-DownloadWarranty, 4-PhysicalShipment, 5-BundledProduct,
6-RecurringPrice, 7-ProductSelection, 8-ManualProcessingFee.
orderItemTypeName
string
The text representation of the order item type ID.
licenseKeys
array[string]
The license key(s) associated with the order item.
subscriptionId
integer
The subscription ID.
subscriptionBillingCycle
integer
The billing cycle of the subscription.
billingPriceTaxRefund
number
The refunded tax amount for all units. Always positive value.
billingPriceRefund
number
The refunded amount excluding the tax amount for all units. Always positive value.
balanceVendorAmount
number
The vendor amount per item in a vendor balance currency.
balancePayProAmount
number
PayPro Global’s commission per item in a vendor balance currency.
sku
string
Product SKU value.
customFields
dictionary<string,string>
The custom fields used in the order.
billingRefundedAmount
number
The refunded amount in a billing currency.
balanceRefundedAmount
number
The refunded amount in a balance currency.
invoiceLink
string
The link to the customer's invoice.
optionGroupIds
number
Product multiple option group ID.
optionGroupItemIds
number
Product multiple option group item ID.
coupons
array[object]
name
string
A coupon code name.
isPercentage
boolean
Possible values are true or false. If true, the percentage discount was applied; false otherwise.
discount
number
The percentage or amount of the discount applied by the coupon.
cyclesLeft
number
The number of remaining cycles the coupon can be used before expiration.
orderStatusReason
string
The reason of the order status in case the order was canceled.
creditCardLast4
string
The last 4 digits of the used credit card.
creditCardExpirationDate
string
The credit card expiration date (MM/YY).
isTestMode
boolean
Possible values are true or false. If true, the test mode was used, false otherwise.
billingTotalPrice
number
The order total price in a billing currency.
billingTotalTaxes
number
The total tax amount in a billing currency.
balanceTotalPrice
number
The order total price in a vendor balance currency.
balanceTotalTaxes
number
The total tax amount in a vendor balance currency.
balanceVendorTotalAmount
number
The total amount in a vendor balance currency transferred to the vendor balance.
balancePayProTotalAmount
number
PayPro Global’s commission for the order converted into the vendor balance currency.
request
object
orderId
integer
The order ID for which you want to get the details.
dateFormat
string
The date format in which you want to get the order details.
Possible values:
a - "yyyy-MM-ddTHH:mm:ss.fff"
b - "M/d/yyyy"
c - "d-MMM-yyyy"
vendorAccountId
integer
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
  "orderId": 12345678,
  "dateFormat": "a",
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "response": {
    "orderId": 12345678,
    "orderStatusId": 5,
    "orderStatusName": "Processed",
    "paymentMethodId": 2,
    "paymentMethodName": "Visa",
    "createdAt": "2023-09-09T11:44:10.417",
    "mainProductId": 12345,
    "billingCurrencyCode": "USD",
    "balanceCurrencyCode": null,
    "customer": {
      "customerId": 12344321,
      "firstName": "John",
      "lastName": "Doe",
      "companyName": null,
      "email": "[email protected]",
      "phone": "+1-001-12345679",
      "country": "Canada",
      "state": null,
      "city": "null",
      "address": "17 test street name",
      "zipCode": "12345",
      "streetNumber": null,
      "taxNumber": null,
      "fiscalNumberPersonal": null,
      "fiscalNumberCorporate": null,
      "payPalAccount": null
    },
    "affiliateIds": [],
    "orderItems": [{
      "orderItemId": 87654321,
      "productId": 12345,
      "orderId": 12345678,
      "vendorAccountId": 3,
      "orderItemName": "Product1",
      "quantity": 1,
      "billingPrice": 100.00,
      "appliedDiscountCouponCode": null,
      "dateCreated": "2023-09-09T11:44:10.417",
      "orderItemTypeId": 1,
      "orderItemTypeName": "Product",
      "licenseKeys": [],
      "subscriptionId": 1111111,
      "subscriptionBillingCycle": 1,
      "billingPriceTaxRefund": 4.00,
      "billingPriceRefund": 20.00,
      "balanceVendorAmount": 0.0,
      "balancePayProAmount": 0.0,
      "sku": "bus100usd"
    }],
    "customFields": [],
    "billingRefundedAmount": 20.00,
    "balanceRefundedAmount": 0.0,
    "invoiceLink": "https://invoice_example",
    "optionGroupIds": [12354],
    "optionGroupItemIds": [12543],
    "coupons": [
      {
        "name": "coupon_name",
        "isPercentage": true,
        "discount": 20.00,
        "cyclesLeft": null
      }
    ],
    "orderStatusReason": null,
    "creditCardLast4": "1798",
    "creditCardExpirationDate": "04/24",
    "isTestMode": true,
    "billingTotalPrice": 100.00,
    "billingTotalTaxes": 20.00,
    "balanceTotalPrice": 0.0,
    "balanceTotalTaxes": 0.0,
    "balanceVendorTotalAmount": 0.0,
    "balancePayProTotalAmount": 0.0
  },
  "request": {
    "orderId": 12345678,
    "dateFormat": "a",
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}