List orders

GET

orders

List orders

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/orders \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/orders"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

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

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "orders": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>",
      "total_amount": 123,
      "currency": "USD",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "due_date": "2023-12-25",
      "invoiced": true,
      "recipient": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "company_name": "<string>",
        "display_name": "<string>"
      }
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Query Parameters

page

integer

default:1

Page number for pagination.

per_page

integer

default:20

Number of records per page.

sort_col

string

Column to sort by

sort_direction

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

keyword

string

Search term.

date_range

string

Filter by date range. Format: 'MM-DD-YYYY,MM-DD-YYYY' (both dates inclusive). If only one date is provided, it is used as both the start and end.

Example:

"06-01-2024,06-11-2025"

amount_range

string

Filter by amount range, in cents. Format: '[min,max]'. Use '[200,]' for at-least, '[,200]' for at-most, '[100,500]' for a range.

Example:

"[100,500]"

Response

Successful operation

orders

object[]

Show child attributes

meta

object

Show child attributes

⌘I

List orders

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/orders \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/orders"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

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

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "orders": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>",
      "total_amount": 123,
      "currency": "USD",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "due_date": "2023-12-25",
      "invoiced": true,
      "recipient": {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "company_name": "<string>",
        "display_name": "<string>"
      }
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Authorizations

Query Parameters

Response