FaxStore

Our Discord

Weblutions Documentation / FaxStore / Quotes API

Quotes API

The Quotes API for FaxStore allows issuing and retrieving quotes for users. It streamlines the process of managing and delivering price estimates directly to your customers.

Table of Contents

Get All Quotes

GET/api/quotes

Returns all quotes created in an array.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "id": 39,
    "uid": "183355725132050432",
    "title": "Quote Item Title",
    "description": "This is a quote description",
    "price": "10.00",
    "agree": "",
    "createdAt": "1699940740527"
  },
  ...
]

404Not Foundplaintext

View response body

Quotes not found.

Examples

curl -X GET 'https://api.example.com/api/quotes' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/quotes', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/quotes', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/quotes', false, $context);
$data = json_decode($response, true);

Get Single Quote

GET/api/quotes/:id

Returns an object of the specified quote.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	String	required	The ID of a quote to fetch.

Responses

200OKjson

View response body

{
    "id": 39,
    "uid": "183355725132050432",
    "title": "Quote Item Title",
    "description": "This is a quote description",
    "price": "10.00",
    "agree": "",
    "createdAt": "1699940740527"
}

404Not Foundplaintext

View response body

Quote not found.

Examples

curl -X GET 'https://api.example.com/api/quotes/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/quotes/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/quotes/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/quotes/123', false, $context);
$data = json_decode($response, true);

Create Quote

POST/api/quote

Creates a quote with the provided data and returns it. Note agree field can't be entered via the API as it is for user agreement in a quote.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
title	String	required	The title of the quote.
description	String	optional	The body content for the quote.
price	String	optional	The proposed price of the quote.

Responses

200OKjson

View response body

{
    "id": 39,
    "uid": "183355725132050432",
    "title": "Quote Item Title",
    "description": "This is a quote description",
    "price": "10.00",
    "agree": "",
    "createdAt": "1699940740527"
}

404Not Foundplaintext

View response body

Quote not found.

Examples

curl -X POST 'https://api.example.com/api/quote' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "example_title",
  "description": "example_description",
  "price": "example_price"
}'

const response = await fetch('https://api.example.com/api/quote', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "title": "example_title",
  "description": "example_description",
  "price": "example_price"
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/quote', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "title": "example_title",
    "description": "example_description",
    "price": "example_price"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "title" => "example_title",
        "description" => "example_description",
        "price" => "example_price"
    ])
  ]
]);

$response = file_get_contents('https://api.example.com/api/quote', false, $context);
$data = json_decode($response, true);

Document History

Loading version history...