List house accounts

curl --request GET \
  --url https://api.vori.com/v1/house-accounts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vori.com/v1/house-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vori.com/v1/house-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vori.com/v1/house-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/house-accounts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "balance": "199.99",
      "created_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "last_order_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone_number": "<string>",
      "shopper_facing_id": "<string>",
      "status": "active",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true
}

{
  "error_code": "conflicting_list_parameters"
}

{
  "error_code": "capability_not_enabled"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {
    "action": "*",
    "resource": "*"
  }
}

GET

house-accounts

List house accounts

curl --request GET \
  --url https://api.vori.com/v1/house-accounts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vori.com/v1/house-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vori.com/v1/house-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vori.com/v1/house-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vori.com/v1/house-accounts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "balance": "199.99",
      "created_at": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com",
      "last_order_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "phone_number": "<string>",
      "shopper_facing_id": "<string>",
      "status": "active",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true
}

{
  "error_code": "conflicting_list_parameters"
}

{
  "error_code": "capability_not_enabled"
}

{
  "error_code": "insufficient_permissions",
  "error_details": {
    "action": "*",
    "resource": "*"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

balance

string

Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Compared as stored, so balance[lte]=-100 finds the accounts owing 100 or more.

balance[gt]

string

balance[gte]

string

balance[lt]

string

balance[lte]

string

ending_before

string

Return records that precede the record with this ID, in list order.

limit

integer

default:20

Maximum number of records to return.

Required range: 1 <= x <= 100

shopper_facing_id

string

Account number the store gives the customer, and what a cashier looks the account up by. Unique within the banner. Matched exactly.

Maximum string length: 255

starting_after

string

Return records that follow the record with this ID, in list order.

status

enum<string>[]

Whether the account may be charged. A suspended or deactivated account cannot be charged at the register, though a suspended one still accepts payments against what is owed. Repeat to match any of up to 20 values.

Available options:

active,

deactivated,

suspended

Response

data

object[]

required

Show child attributes

has_more

boolean

required

Whether more records follow this page.