Get order

GET/orders/{orderId}

Use it to get order

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/orders/ORDER_ID' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/orders/ORDER_ID', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/orders/ORDER_ID"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "id": "5d6e7f80-9a1b-4c2d-8e3f-4a5b6c7d8e9f",
    "date": "2026-01-15T12:00:00.000Z",
    "paidAt": "2026-01-15T12:05:00.000Z",
    "status": "paid",
    "orderBuyer": {
      "name": "Maria Silva",
      "email": "maria@example.com",
      "phone": {
        "areaCode": "+55",
        "ddd": "11",
        "number": "912345678",
        "isMobile": true
      },
      "address": {
        "zipCode": null,
        "street": null,
        "number": null,
        "complement": null,
        "neighborhood": null,
        "city": null,
        "state": null
      },
      "document": {
        "type": "CPF",
        "number": "12345678909"
      },
      "deliveryAddress": {
        "zipCode": null,
        "street": null,
        "number": null,
        "complement": null,
        "neighborhood": null,
        "city": null,
        "state": null
      }
    },
    "coupon": {
      "code": null,
      "totalDiscountValueInCents": 0,
      "percentage": 0,
      "valueInCents": 0
    },
    "items": [
      {
        "id": "6e7f8091-ab2c-4d3e-9f40-5b6c7d8e9fa0",
        "orderId": "5d6e7f80-9a1b-4c2d-8e3f-4a5b6c7d8e9f",
        "product": {
          "id": "7f8091a2-bc3d-4e4f-a051-6c7d8e9fa0b1",
          "name": "Online course",
          "image": {
            "name": "cover.jpeg",
            "path": "product/7f8091a2-bc3d-4e4f-a051-6c7d8e9fa0b1",
            "url": "https://example.com/product/7f8091a2-bc3d-4e4f-a051-6c7d8e9fa0b1/cover.jpeg",
            "isPublic": true,
            "extension": "jpeg"
          }
        },
        "unitValueInCents": 6000,
        "quantity": 1,
        "subscription": {
          "id": "8091a2b3-cd4e-4f50-b162-7d8e9fa0b1c2",
          "name": "Monthly plan",
          "expiration": null,
          "periodicity": "Monthly",
          "numberRecurrences": 0,
          "status": "active",
          "recurrenceValueInCents": 6000,
          "paymentMethod": "credit-card",
          "repeatIndefinitely": true,
          "recurrences": [
            {
              "billingDate": "2026-01-15T12:00:00.000Z",
              "dueDate": "2026-01-15T12:00:00.000Z",
              "paidAt": "2026-01-15T12:05:00.000Z",
              "recurrenceValueInCents": 6000,
              "status": "paid",
              "recurrence": 1
            },
            {
              "billingDate": "2026-02-15T03:00:00.000Z",
              "dueDate": "2026-02-15T03:00:00.000Z",
              "paidAt": null,
              "recurrenceValueInCents": 6000,
              "status": "pending",
              "recurrence": 2
            }
          ]
        }
      }
    ],
    "taxes": [],
    "payments": [
      {
        "payment": {
          "id": "91a2b3c4-de5f-4061-8273-8e9fa0b1c2d3",
          "status": "paid",
          "valuePaidInCents": 6978,
          "externalId": null,
          "fineValueInCents": 0,
          "installments": 6,
          "interestValueInCents": 978,
          "paymentMethod": "credit-card",
          "statusHistory": [
            {
              "id": "a2b3c4d5-ef60-4172-9384-9fa0b1c2d3e4",
              "status": "pending",
              "date": "2026-01-15T12:00:00.000Z"
            },
            {
              "id": "b3c4d5e6-f071-4283-a495-a0b1c2d3e4f5",
              "status": "in-processing",
              "date": "2026-01-15T12:00:10.000Z"
            },
            {
              "id": "c4d5e6f7-0182-4394-b5a6-b1c2d3e4f5a6",
              "status": "authorized",
              "date": "2026-01-15T12:00:20.000Z"
            },
            {
              "id": "d5e6f708-1293-44a5-86b7-c2d3e4f5a6b7",
              "status": "paid",
              "date": "2026-01-15T12:05:00.000Z"
            }
          ],
          "valueInCents": 6978,
          "creditCard": {
            "nickname": "Personal card",
            "last4Numbers": "1111",
            "holderName": "MARIA SILVA",
            "expiresAtMonth": 12,
            "expiresAtYear": 2030,
            "flag": "visa"
          }
        }
      }
    ],
    "statusHistory": [
      {
        "id": "e6f70819-23a4-45b6-97c8-d3e4f5a6b7c8",
        "status": "pending",
        "date": "2026-01-15T12:00:00.000Z"
      },
      {
        "id": "f708192a-34b5-46c7-a8d9-e4f5a6b7c8d9",
        "status": "paid",
        "date": "2026-01-15T12:05:00.000Z"
      }
    ],
    "paymentTaxes": [
      {
        "paymentId": "91a2b3c4-de5f-4061-8273-8e9fa0b1c2d3",
        "taxes": [
          {
            "taxName": "Processing fee",
            "totalValueInCents": 349,
            "payer": "seller",
            "percentage": 5
          }
        ]
      }
    ]
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Path parameters

orderIdstringrequired