List Orders

The “List Orders” API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information.

GET https://services.leadconnectorhq.com/payments/orders

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Query parameters

string

default:"3SwdhCu3svxI8AKsPJt6"

LocationId is the id of the account.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

AltId is the unique identifier e.g: account id.

string

default:"completed"

Order status.

string

default:"unpaid"

Payment Status of the Order

string

default:"live"

Mode of payment.

string

default:"2024-02-01"

Starting interval of orders.

string

default:"2024-02-13"

Closing interval of orders.

string

default:"Awesome order"

The name of the order for searching.

string

default:"XPLSw2SVagl12LMDeTmQ"

Contact id for filtering of orders.

string

Funnel product ids separated by comma.

string

default:"61dd0c7dc077f712a5f787ff"

Source id

number

default:"20"

The maximum number of items to be included in a single page of results

number

default:"0"

The starting index of the page, indicating the position from which the results should be retrieved.

Respuestas

200 - Successful response

object[]

required

An array of orders

Show cada item

string

default:"653f5e0cde5a1314e62a837c"

required

The unique identifier for the order.

string

default:"3SwdhCu3svxI8AKsPJt6"

required

AltId is the unique identifier eg: account id.

string

default:"account"

required

AltType is the type of identifier.

string

default:"XPLSw2SVagl12LMDeTmQ"

Contact id corresponding to the order.

string

default:"James Bond"

Contact name corresponding to the order.

string

default:"james.bond@leadwaycrm.com"

Contact email corresponding to the order.

string

default:"USD"

Currency in which order was created.

number

default:"100"

Order value.

number

default:"100"

Order sub-total value.

number

default:"10"

Discount value on order.

string

default:"completed"

required

The status of the order (e.g., completed).

boolean

default:"false"

Order is in live / test mode.

number

default:"5"

Total products in an order.

string

default:"funnel"

required

Source type of order (eg: funnel).

string

default:"onestep"

Source name for the order.

string

default:"kDj7BHej9Zyyq3QakJmz"

Source id for the order.

object

Meta content for the source of order.

string

default:"100PER"

Coupon code for the order.

string

default:"2023-11-20T10:23:36.515Z"

required

The creation timestamp of the order.

string

default:"2024-01-23T09:57:04.846Z"

required

The last update timestamp of the order.

string

default:"one_step_order_form"

Source sub-type for the order.

string

default:"unfulfilled"

Fulfillment status of the order.

number

default:"1"

Total one time products in an order.

number

default:"1"

Total recurring time products in an order.

string

default:"user123"

User ID who created the order.

number

required

total orders count

{
  "data": [
    {
      "_id": "653f5e0cde5a1314e62a837c",
      "altId": "3SwdhCu3svxI8AKsPJt6",
      "altType": "account",
      "contactId": "XPLSw2SVagl12LMDeTmQ",
      "contactName": "James Bond",
      "contactEmail": "james.bond@leadwaycrm.com",
      "currency": "USD",
      "amount": "100",
      "subtotal": "100",
      "discount": "10",
      "status": "completed",
      "liveMode": "false",
      "totalProducts": "5",
      "sourceType": "funnel",
      "sourceName": "onestep",
      "sourceId": "kDj7BHej9Zyyq3QakJmz",
      "sourceMeta": "{ domain: \"app.leadwaycrm.com\", pageId:  \"rBVhyYhMsbxbO8ZqOcei\", pageUrl:  \"/v2/preview/rBVhyYhMsbxbO8ZqOcei\", stepId:   \"5a772f62-3fbc-418b-af1b-be8929dd64c2\"}",
      "couponCode": "100PER",
      "createdAt": "2023-11-20T10:23:36.515Z",
      "updatedAt": "2024-01-23T09:57:04.846Z",
      "sourceSubType": "one_step_order_form",
      "fulfillmentStatus": "unfulfilled",
      "onetimeProducts": "1",
      "recurringProducts": "1",
      "createdBy": "user123"
    }
  ],
  "totalCount": 0
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/payments/orders' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/payments/orders', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/payments/orders',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/payments/orders');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Query parameters

Respuestas

Ejemplo

​Autorización

​Query parameters

​Respuestas

​Ejemplo

Autorización

Query parameters

Respuestas

Ejemplo