When using Order Flow remote handlers, specific sets of data will be passed in requests (external posts) to an external system depending of the value selected in the Request data format field:
- Order data
- Order and customer data
- Order, customer and payment data
Below are examples of data packages which can be sent using Remote Order Handlers.
Order Data
{
"order":{
# Node containing Order properties
"orderId":1001250,
# All properties values are taken directly from Billing DB when not stated explicitly.
"orderNbr":"SO000031",
"orderType":"SO",
"orderStatus":"W5",
"currency":"USD",
"merchantTotal":20.0,
"total":20.0,
"taxTotal":0.0,
"extraTaxTotal":0.0,
# Calculated as Total - Merchant Total
"salesId":null,
"salesBranch":null,
"orderDetails":[
# Array containing list of Order Details {
# Node containing Order Detail properties
"id":451,
# All properties values are taken directly from Billing DB when not stated explicitly.
"type":110,
"resourceId":null,
"subscriptionID":1000083,
"promoID":null,
"duration":1.0,
"durPeriod":1,
"pricePeriodType":0,
"durPeriodType":2,
"description":"dummy_plan Recurring",
"sku":null,
"quantity":1.0,
"unitOfMeasure":"item",
"unitPrice":20.0,
"taxAmount":0.0,
"includedTaxAmount":0.0,
"extraTaxAmount":0.0,
# Calculated as Tax Amount - Included Tax Amount
"discountAmount":0.0,
"extendedPrice":20.0,
"plan":{
# Service Plan properties
"planId":4,
"name":"dummy_plan",
"serviceTemplate":{
# Service Template properties
"serviceTemplateId":1000004,
"name":"dummy_tmp"
}
}
}
]
},
"requestId":1 # Remote Request ID
}
Order and customer data
{
"account":{
# Node containing Customer Account properties
"accountId":1000001,
# All properties values are taken directly from Billing DB when not stated explicitly.
"vendorAccountId":1,
"type":3,
"accCurrencyId":"USD",
"customerClassName":"Default",
"customerClassId":0,
"taxRegId":null,
"taxRegIdStatus":0,
"taxZoneId":"World-Rest",
"companyName":"customer1",
"companyNameLatin":null,
"address":{
"address1":"Moscow",
"address2":null,
"city":"Moscow",
"state":null,
"zip":"1231",
"countryID":"ru",
"postalAddress":null
},
"adminContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"billingContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"technicalContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"personalContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"birthday":0,
"passport":null,
"taxStatus":2,
"salesId":null,
"branchId":null,
"localeId":"en",
"attributes":[
]
},
"vendor":{
# Node containing Vendor Account properties
"accountId":1,
# Structure is the same as for Customer Account
"vendorAccountId":null,
# All properties values are taken directly from Billing DB when not stated explicitly.
"type":0,
"accCurrencyId":"USD",
"customerClassName":"Default",
"customerClassId":0,
"taxRegId":null,
"taxRegIdStatus":null,
"taxZoneId":null,
"companyName":"ServicePro",
"companyNameLatin":null,
"address":{
"address1":"Moscow",
"address2":null,
"city":"Moscow",
"state":null,
"zip":"1231",
"countryID":"us",
"postalAddress":null
},
"adminContact":{
"firstName":"Charlie",
"middleName":null,
"lastName":"Root",
"email":"root@POAMN-0a15827c882d.aqa.int.zone",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"billingContact":{
"firstName":"Charlie",
"middleName":null,
"lastName":"Root",
"email":"root@POAMN-0a15827c882d.aqa.int.zone",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"technicalContact":{
"firstName":"Charlie",
"middleName":null,
"lastName":"Root",
"email":"root@POAMN-0a15827c882d.aqa.int.zone",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"personalContact":{
"firstName":null,
"middleName":null,
"lastName":null,
"email":null,
"phoneCountryCode":null,
"phoneAreaCode":null,
"phoneNumber":null,
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"birthday":0,
"passport":null,
"taxStatus":2,
"salesId":null,
"branchId":null,
"localeId":"en",
"attributes":[
]
},
"order":{
# Node containing Order properties
"orderId":1001252,
# All properties values are taken directly from Billing DB when not stated explicitly.
"orderNbr":"SO000032",
"orderType":"SO",
"orderStatus":"W5",
"currency":"USD",
"merchantTotal":20.0,
"total":20.0,
"taxTotal":0.0,
"extraTaxTotal":0.0,
# Calculated as Total - Merchant Total
"salesId":null,
"salesBranch":null,
"orderDetails":[
# Array containing list of Order Details {
# Node containing Order Detail properties
"id":452,
# All properties values are taken directly from Billing DB when not stated explicitly.
"type":110,
"resourceId":null,
"subscriptionID":1000084,
"promoID":null,
"duration":1.0,
"durPeriod":1,
"pricePeriodType":0,
"durPeriodType":2,
"description":"dummy_plan Recurring",
"sku":null,
"quantity":1.0,
"unitOfMeasure":"item",
"unitPrice":20.0,
"taxAmount":0.0,
"includedTaxAmount":0.0,
"extraTaxAmount":0.0,
# Calculated as Tax Amount - Included Tax Amount
"discountAmount":0.0,
"extendedPrice":20.0,
"plan":{
# Service Plan properties
"planId":4,
"name":"dummy_plan",
"serviceTemplate":{
# Service Template properties
"serviceTemplateId":1000004,
"name":"dummy_tmp"
}
}
}
],
"vendorCosts":[
] # Node containing Vendor Costs.
# Structure is the same as for Order Details.
# Purpose is to show what reseller pays for.
# List is not empty when Delegated Plan is purchased.
},
"requestId":2 # Remote Request ID
}
Order, customer and payment data
{
"account":{
# Node containing Customer Account properties
"accountId":1000001,
# All properties values are taken directly from Billing DB when not stated explicitly.
"vendorAccountId":1,
"type":3,
"accCurrencyId":"USD",
"customerClassName":"Default",
"customerClassId":0,
"taxRegId":null,
"taxRegIdStatus":0,
"taxZoneId":"World-Rest",
"companyName":"customer1",
"companyNameLatin":null,
"address":{
"address1":"Moscow",
"address2":null,
"city":"Moscow",
"state":null,
"zip":"1231",
"countryID":"ru",
"postalAddress":null
},
"adminContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"billingContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"technicalContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"personalContact":{
"firstName":"customer1",
"middleName":null,
"lastName":"customer1",
"email":"customer1@mail.test",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"birthday":0,
"passport":null,
"taxStatus":2,
"salesId":null,
"branchId":null,
"localeId":"en",
"attributes":[
]
},
"vendor":{
# Node containing Vendor Account properties
"accountId":1,
# Structure is the same as for Customer Account
"vendorAccountId":null,
# All properties values are taken directly from Billing DB when not stated explicitly.
"type":0,
"accCurrencyId":"USD",
"customerClassName":"Default",
"customerClassId":0,
"taxRegId":null,
"taxRegIdStatus":null,
"taxZoneId":null,
"companyName":"ServicePro",
"companyNameLatin":null,
"address":{
"address1":"Moscow",
"address2":null,
"city":"Moscow",
"state":null,
"zip":"1231",
"countryID":"us",
"postalAddress":null
},
"adminContact":{
"firstName":"Charlie",
"middleName":null,
"lastName":"Root",
"email":"root@POAMN-0a15827c882d.aqa.int.zone",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"billingContact":{
"firstName":"Charlie",
"middleName":null,
"lastName":"Root",
"email":"root@POAMN-0a15827c882d.aqa.int.zone",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"technicalContact":{
"firstName":"Charlie",
"middleName":null,
"lastName":"Root",
"email":"root@POAMN-0a15827c882d.aqa.int.zone",
"phoneCountryCode":"123",
"phoneAreaCode":"123",
"phoneNumber":"123123",
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"personalContact":{
"firstName":null,
"middleName":null,
"lastName":null,
"email":null,
"phoneCountryCode":null,
"phoneAreaCode":null,
"phoneNumber":null,
"phoneExtention":null,
"faxCountryCode":null,
"faxAreaCode":null,
"faxNumber":null,
"faxExtention":null
},
"birthday":0,
"passport":null,
"taxStatus":2,
"salesId":null,
"branchId":null,
"localeId":"en",
"attributes":[
]
},
"order":{
# Node containing Order properties
"orderId":1001254,
# All properties values are taken directly from Billing DB when not stated explicitly.
"orderNbr":"SO000033",
"orderType":"SO",
"orderStatus":"W5",
"currency":"USD",
"merchantTotal":20.0,
"total":20.0,
"taxTotal":0.0,
"extraTaxTotal":0.0,
# Calculated as Total - Merchant Total
"salesId":null,
"salesBranch":null,
"orderDetails":[
# Array containing list of Order Details {
# Node containing Order Detail properties
"id":453,
# All properties values are taken directly from Billing DB when not stated explicitly.
"type":110,
"resourceId":null,
"subscriptionID":1000085,
"promoID":null,
"duration":1.0,
"durPeriod":1,
"pricePeriodType":0,
"durPeriodType":2,
"description":"dummy_plan Recurring",
"sku":null,
"quantity":1.0,
"unitOfMeasure":"item",
"unitPrice":20.0,
"taxAmount":0.0,
"includedTaxAmount":0.0,
"extraTaxAmount":0.0,
# Calculated as Tax Amount - Included Tax Amount
"discountAmount":0.0,
"extendedPrice":20.0,
"plan":{
# Service Plan properties
"planId":4,
"name":"dummy_plan",
"serviceTemplate":{
# Service Template properties
"serviceTemplateId":1000004,
"name":"dummy_tmp"
}
}
}
],
"vendorCosts":[
],
# Node containing Vendor Costs.
# Structure is the same as for Order Details.
# Purpose is to show what reseller pays for.
# List is not empty when Delegated Plan is purchased.
"payments":[
# Array node containing Payments data which are assigned to the Order {
# Payment data node
"id":387,
# All properties values are taken directly from Billing DB when not stated explicitly.
"total":20.0,
"currency":"USD",
"description":"Paying order SO000033",
"client_ip":"10.192.38.20",
"paytool":{
# Payment Method data node
"type":6,
# All properties values are taken directly from Billing DB when not stated explicitly.
"email":null,
"address1":null,
"address2":null,
"city":null,
"state":null,
"zip":null,
"system":"Demo.Token",
"cutNumber":"**** **** **** 4462",
"cutNumber2":"**** **** **** 4462",
"params":[
# Array node containing Payment Method parameters (attributes) {
"id":"EXP_DATE",
# Parameter ID
"value":"1220" # Parameter Value
}
]
}
}
]
},
"requestId":3 # Remote Request ID
}