Skip to content

GET Get One Order

Base URLs

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

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

{{base_url}}/orders/{{id}}

Description

This endpoint is used to retrieve detailed information about a specific order in the system. By providing the order ID, you can access comprehensive details such as the order's status, product type, associated campaign, and creator information. The response includes all relevant data related to the specified order.

AUTHORIZATION

Bearer Token

  • Token: {{jwt_token}}

Example Request

curl --location -g '{{base_url}}/orders/16'

Example Response

{
  "message": "Success",
  "data": {
    "id": "16",
    "orgId": "1",
    "templateUrl": "https://api.openletterconnect.com/api/v1/download/s3/openletterconnect/org-1/user-8/templates/upload/json/1703258445394-template.json",
    "backTemplateUrl": null,
    "mergeVariables": {},
    "status": "On Hold",
    "meta": {},
    "isLiveMode": false,
    "campaign": {
      "scheduleType": "immediate",
      "deliveryDate": null,
      "createdAt": "2023-12-29T08:38:17.169Z"
    },
    "product": {
      "productType": "Personal Letters"
    },
    "createdBy": "6",
    "source": "OLC Client",
    "creator": {
      "id": "6",
      "fullName": "Usman Iqbal"
    }
  }
}