Skip to main content

Assign Affiliate to Order

Assign the affiliate to the order.

Request Parametersapplication/json
AssignToOrderRequestModel
object
affiliateAgreementId
integer
required
The ID of the agreement with your affiliate.
It can be found in your PayPro Global account > Affiliates > Agreements.
orderId
integer
required
The order ID to which the affiliate should be assigned.
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
AssignToOrderResponseModel
object
request
object
affiliateAgreementId
integer
The ID of the agreement with your affiliate.
It can be found in your PayPro Global account > Affiliates > Agreements.
orderId
integer
The order ID to which the affiliate should be assigned.
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
{
"affiliateAgreementId": 1,
"orderId": 5458995,
"vendorAccountId": 123456,
"apiSecretKey": "your_api_secret_key"
}
Response Sample
{
"request": {
"affiliateAgreementId": 1,
"orderId": 5458995,
"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
}