Create a house account

curl --request POST \
  --url https://api.vori.com/v1/house-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "shopper_facing_id": "<string>",
  "balance": "199.99",
  "email": "jsmith@example.com",
  "phone_number": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "shopper_facing_id": "<string>",
    "balance": "199.99",
    "email": "jsmith@example.com",
    "phone_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    shopper_facing_id: '<string>',
    balance: '199.99',
    email: 'jsmith@example.com',
    phone_number: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'shopper_facing_id' => '<string>',
    'balance' => '199.99',
    'email' => 'jsmith@example.com',
    'phone_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"shopper_facing_id\": \"<string>\",\n  \"balance\": \"199.99\",\n  \"email\": \"jsmith@example.com\",\n  \"phone_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vori.com/v1/house-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"shopper_facing_id\": \"<string>\",\n  \"balance\": \"199.99\",\n  \"email\": \"jsmith@example.com\",\n  \"phone_number\": \"<string>\"\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"shopper_facing_id\": \"<string>\",\n  \"balance\": \"199.99\",\n  \"email\": \"jsmith@example.com\",\n  \"phone_number\": \"<string>\"\n}"

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

{
  "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"
}

{
  "error_code": "duplicate_house_account_shopper_facing_id",
  "house_account_id": "<string>",
  "shopper_facing_id": "<string>"
}

{
  "error_code": "capability_not_enabled"
}

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

POST

house-accounts

Create a house account

curl --request POST \
  --url https://api.vori.com/v1/house-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "shopper_facing_id": "<string>",
  "balance": "199.99",
  "email": "jsmith@example.com",
  "phone_number": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "shopper_facing_id": "<string>",
    "balance": "199.99",
    "email": "jsmith@example.com",
    "phone_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    shopper_facing_id: '<string>',
    balance: '199.99',
    email: 'jsmith@example.com',
    phone_number: '<string>'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'shopper_facing_id' => '<string>',
    'balance' => '199.99',
    'email' => 'jsmith@example.com',
    'phone_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"shopper_facing_id\": \"<string>\",\n  \"balance\": \"199.99\",\n  \"email\": \"jsmith@example.com\",\n  \"phone_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vori.com/v1/house-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"shopper_facing_id\": \"<string>\",\n  \"balance\": \"199.99\",\n  \"email\": \"jsmith@example.com\",\n  \"phone_number\": \"<string>\"\n}")
  .asString();

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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"shopper_facing_id\": \"<string>\",\n  \"balance\": \"199.99\",\n  \"email\": \"jsmith@example.com\",\n  \"phone_number\": \"<string>\"\n}"

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

{
  "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"
}

{
  "error_code": "duplicate_house_account_shopper_facing_id",
  "house_account_id": "<string>",
  "shopper_facing_id": "<string>"
}

{
  "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.

Body

application/json

name

string

required

Name the account is held under, usually the customer or business it belongs to.

shopper_facing_id

string

required

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

balance

string<monetary>

Balance to open the account with. Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend. Defaults to zero.

Pattern: ^-?[0-9]+(\.[0-9]+)?$

Example:

"199.99"

string<email> | null

Email address on file for the account holder.

Maximum string length: 254

phone_number

string<phone> | null

Phone number on file for the account holder.

Pattern: ^\+[1-9]\d{1,14}$

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. Defaults to active.

Available options:

active,

deactivated,

suspended

Response

A charge account, or tab, a store lets a customer buy against and settle later. A house account belongs to the banner rather than to any one store, and can be charged at any of its registers.

string

required

Unique identifier for the record.

balance

string<monetary>

required

Money on the account. A negative balance is what the customer owes the store; a positive balance is credit they can spend.

Pattern: ^-?[0-9]+(\.[0-9]+)?$

Example:

"199.99"

created_at

string<date-time>

required

When the record was created.

string<email> | null

required

Email address on file for the account holder.

Maximum string length: 254

last_order_at

string<date-time> | null

required

When an order was last charged to or refunded against this account. Null if it has never been used at a register.

name

string

required

Name the account is held under, usually the customer or business it belongs to.

phone_number

string<phone> | null

required

Phone number on file for the account holder.

Pattern: ^\+[1-9]\d{1,14}$

shopper_facing_id

string

required

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

status

enum<string>

required

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.

Available options:

active,

deactivated,

suspended

updated_at

string<date-time>

required

When the record was last changed.