GET Order Details Analytics

Base URLs

Demo URL: https://demoapi.openletterconnect.com/api/v1

Production URL: https://api.openletterconnect.com/api/v1

{{base_url}}/orders/detail/analytics/1

Description

This endpoint is used to retrieve detailed information about a specific order, including associated contacts. By providing the order ID, you can access comprehensive details such as the order's status, product type, and related contact information. The response will include all relevant data related to the specified order.

AUTHORIZATION

Bearer Token

• Token: {{jwt_token}}

Example Request

curl --location -g '{{base_url}}/orders/detail/analytics/1'

Example Response

{
  "message": "Success",
  "data": {
    "orderItemStatuses": {
      "Mailed": 2,
      "In Transit": 1,
      "Delivered": 0,
      "Re-Routed": 0,
      "Returned to Sender": 0
    },
    "geoChart": {
      "chartData": {
        "MA": {
          "name": "Massachusetts",
          "count": null
        },
        "RI": {
          "name": "Rhode Island",
          "count": null
        },
        "NH": {
          "name": "New Hampshire",
          "count": 1
        },
        "ME": {
          "name": "Maine",
          "count": null
        },
        "VT": {
          "name": "Vermont",
          "count": null
        },
        "CT": {
          "name": "Connecticut",
          "count": null
        },
        "NJ": {
          "name": "New Jersey",
          "count": null
        },
        "NY": {
          "name": "New York",
          "count": null
        },
        "PA": {
          "name": "Pennsylvania",
          "count": null
        },
        "DE": {
          "name": "Delaware",
          "count": null
        },
        "MD": {
          "name": "Maryland",
          "count": null
        },
        "VA": {
          "name": "Virginia",
          "count": null
        },
        "WV": {
          "name": "West Virginia",
          "count": null
        },
        "NC": {
          "name": "North Carolina",
          "count": null
        },
        "SC": {
          "name": "South Carolina",
          "count": null
        },
        "GA": {
          "name": "Georgia",
          "count": null
        },
        "FL": {
          "name": "Florida",
          "count": 1
        },
        "AL": {
          "name": "Alabama",
          "count": null
        },
        "TN": {
          "name": "Tennessee",
          "count": null
        },
        "MS": {
          "name": "Mississippi",
          "count": null
        },
        "KY": {
          "name": "Kentucky",
          "count": null
        },
        "OH": {
          "name": "Ohio",
          "count": null
        },
        "IN": {
          "name": "Indiana",
          "count": null
        },
        "MI": {
          "name": "Michigan",
          "count": null
        },
        "IA": {
          "name": "Iowa",
          "count": null
        },
        "WI": {
          "name": "Wisconsin",
          "count": null
        },
        "MN": {
          "name": "Minnesota",
          "count": null
        },
        "SD": {
          "name": "South Dakota",
          "count": null
        },
        "ND": {
          "name": "North Dakota",
          "count": null
        },
        "MT": {
          "name": "Montana",
          "count": null
        },
        "IL": {
          "name": "Illinois",
          "count": null
        },
        "MO": {
          "name": "Missouri",
          "count": null
        },
        "KS": {
          "name": "Kansas",
          "count": null
        },
        "NE": {
          "name": "Nebraska",
          "count": null
        },
        "LA": {
          "name": "Louisiana",
          "count": null
        },
        "AR": {
          "name": "Arkansas",
          "count": null
        },
        "OK": {
          "name": "Oklahoma",
          "count": null
        },
        "TX": {
          "name": "Texas",
          "count": null
        },
        "CO": {
          "name": "Colorado",
          "count": null
        },
        "WY": {
          "name": "Wyoming",
          "count": null
        },
        "ID": {
          "name": "Idaho",
          "count": null
        },
        "UT": {
          "name": "Utah",
          "count": null
        },
        "AZ": {
          "name": "Arizona",
          "count": null
        },
        "NM": {
          "name": "New Mexico",
          "count": null
        },
        "NV": {
          "name": "Nevada",
          "count": null
        },
        "CA": {
          "name": "California",
          "count": 1
        },
        "HI": {
          "name": "Hawaii",
          "count": null
        },
        "OR": {
          "name": "Oregon",
          "count": null
        },
        "WA": {
          "name": "Washington",
          "count": null
        },
        "AK": {
          "name": "Alaska",
          "count": null
        }
      },
      "scannedOrderItems": 3,
      "notScannedOrderItems": 1
    }
  }
}