Skip to main content
GET
/
orders
cURL
curl --request GET \
  --url https://api.konvoai.com/orders \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "result": [
    {
      "id": "be6ed223-19c3-47db-8635-794f856e1956",
      "contactId": "21f0cf2f-30cd-4e13-9cde-7a3e4e77deff",
      "externalName": "1001",
      "externalId": "5210634092624",
      "firstName": "Jeff",
      "lastName": "Bezos",
      "email": "jeff@amazon.com",
      "phoneNumber": "+15551234",
      "orderTotal": 69995,
      "currency": "eur",
      "channel": "SHOPIFY",
      "status": "PAID",
      "trackingUrl": "https://{{YOUR_SHOPIFY_URL}}.myshopify.com/{{EXTERNAL_ID}}",
      "createdAt": "2024-11-07T11:57:25.000Z",
      "updatedAt": "2024-11-07T11:57:25.000Z",
      "shopId": "{{YOUR_SHOPIFY_URL}}.myshopify.com"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer

Pointer for the current page of the paginated query

limit
integer

The maximum number of results to return, maximum is 200

updated_at_min
string

Filter by broadcasts updated after a certain date

updated_at_max
string

Filter by broadcasts updated before a certain date

created_at_min
string

Filter by broadcasts created after a certain date

created_at_max
string

Filter by broadcasts created after a certain date

Response

Get order response

count
integer

Total count of the request

result
object[]

Resulting query