API ReferenceOrder Recipient Analytics
Updates order recipients statistics when a QR Code is scanned
Updates order recipients statistics when a QR Code is scanned
Updates order recipients statistics when a QR Code is scanned
Authorization
ApiKey X-API-KEY<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
orderId*integer
statisticName*OrderStatisticName
statisticValue*string
orderRecipientId*integer
orderRecipient*
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/order-recipients-statistics" \ -H "Content-Type: application/json" \ -d '{ "orderId": 0, "statisticName": 0, "statisticValue": "string", "orderRecipientId": 0, "orderRecipient": { "id": 0, "firstName": "string", "lastName": "string", "toOrganization": "string", "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string", "createdDate": "2019-08-24T14:15:22Z", "qrCode": "string", "qrUrl": "string", "qrCodeScanCount": 0, "customerEmail": "string", "customerName": "string", "customerOrganization": "string", "salespersonName": "string" } }'Empty
{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "statisticName": 0, "statisticValue": "string", "orderRecipientId": 0, "orderRecipient": { "id": 0, "firstName": "string", "lastName": "string", "toOrganization": "string", "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string", "createdDate": "2019-08-24T14:15:22Z", "qrCode": "string", "qrUrl": "string", "qrCodeScanCount": 0, "customerEmail": "string", "customerName": "string", "customerOrganization": "string", "salespersonName": "string" } }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "statisticName": 0, "statisticValue": "string", "orderRecipientId": 0, "orderRecipient": { "id": 0, "firstName": "string", "lastName": "string", "toOrganization": "string", "fullAddress": "string", "address1": "string", "address2": "string", "city": "string", "state": "string", "zipCode": "string", "country": "string", "createdDate": "2019-08-24T14:15:22Z", "qrCode": "string", "qrUrl": "string", "qrCodeScanCount": 0, "customerEmail": "string", "customerName": "string", "customerOrganization": "string", "salespersonName": "string" } }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}