Skip to main content

Get Store Products

Get all store products.

Request Parametersapplication/json
GetStoreProductsRequestModel
object
productIds
array[integer]
The list of product IDs for which you want to get the product details.
productNames
array[string]
The list of product names for which you want to get the product details.
productSKUs
array[string]
The list of product SKU values for which you want to get the product details.
productStatusId
integer
The product status. It can be active (value = 1) or inactive (value = 0).
productChargingTypeId
integer
The product charging type. It can be a one-time payment (value = 1) or a subscription (value = 2).
languageCode
string
The language code. It is used to get the response results
storeProducts name and description in a defined language if needed.
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
GetStoreProductsResponseModel
object
response
object
storeProducts
array[object]
List of store products.
Id
integer
The product ID value.
Name
string
The product name value.
Description
string
The product description value.
Logo
string
The product logo path.
Sku
string
The product SKU value.
request
object
productIds
array[integer]
The list of product IDs for which you want to get the product details.
productNames
array[string]
The list of product names for which you want to get the product details.
productSKUs
array[string]
The list of product SKU values for which you want to get the product details.
productStatusId
integer
The product status. It can be active (value = 1) or inactive (value = 0).
productChargingTypeId
integer
The product charging type. It can be a one-time payment (value = 1) or a subscription (value = 2).
languageCode
string
The language code. It is used to get the response results
storeProducts name and description in a defined language if needed.
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
{
"productIds": [
1,
2
],
"productNames": [
"sample string 1",
"sample string 2"
],
"productSKUs": [
"sample string 1",
"sample string 2"
],
"productStatusId": 1,
"productChargingTypeId": 1,
"languageCode": "sample string 1",
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"response": {
"storeProducts": [
{
"id": 1,
"name": "John Doe",
"description": "sample string 3",
"logo": "sample string 4",
"sku": "ABF-478-5297-RI"
},
{
"id": 1,
"name": "John Doe",
"description": "sample string 3",
"logo": "sample string 4",
"sku": "ABF-478-5297-RI"
}
]
},
"request": {
"productIds": [
1,
2
],
"productNames": [
"sample string 1",
"sample string 2"
],
"productSKUs": [
"sample string 1",
"sample string 2"
],
"productStatusId": 1,
"productChargingTypeId": 1,
"languageCode": "sample string 1",
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
},
"errors": [
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
},
{
"propertyWithError": "orderId",
"propertyErrorMessages": [
"Error message 1",
"Error message 2"
]
}
],
"isSuccess": false
}