Skip to content

LettrLabs Public API Documentation (1.0.0)

LettrLabs Public API Documentation.

Download OpenAPI description
LettrLabs_API_Reference.json
LettrLabs_API_Reference.yaml
Languages
Servers
Mock server

https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/

https://app.lettrlabs.com/api/

Conversions

Operations

Orders

Operations

Automations

Operations

Order Recipient Analytics

Operations

Update QR Scans

Request

Updates order recipients statistics when a QR Code is scanned.

Security
apikey
Bodyapplication/jsonrequired

The Order Recipient Statistic to add or update

orderRecipientIdinteger(int32)

Order Recipient ID

orderRecipientobject(orderRecipient)

Order Recipient

orderIdinteger(int32)

Order ID

statisticNameinteger(int32)

Order Statistic Type

Value0
statisticValuestring

Order Statistic Value

curl -i -X POST \
  https://docs.lettrlabs.com/_mock/lettrlabs_api_reference/v1/order-recipients-statistics \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "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"
    },
    "orderId": 0,
    "statisticName": 0,
    "statisticValue": "string"
  }'

Responses

successful operation

Bodyapplication/json
profileobject(profile)
payloadobject(orderRecipientStatistic)
errorsArray of strings
hasErrorsboolean
warningsArray of strings
hasWarningsboolean
metadataobject
Response
application/json
{
  "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": {
    "orderRecipientId": 0,
    "orderRecipient": { … },
    "orderId": 0,
    "statisticName": 0,
    "statisticValue": "string"
  },
  "errors": [
    "string"
  ],
  "hasErrors": true,
  "warnings": [
    "string"
  ],
  "hasWarnings": true,
  "metadata": {
    "property1": {},
    "property2": {}
  }
}

Address Book

Operations