Get user quotes (Pagination/Summary)

Use this request to retrieve quotes with summary information and pagination capabilities.

To retrieve the quotes for your use, use a GET method and the following URL:
{epal_api_url}/quotes
For example:
https://api.epalglobal.com/quotes

Details

Table 1. Request Details
Detail
Operation GET
Endpoint /quotes
Fields Response only

Response Parameters

Table 2.
Response Parameter Details Description
limit
  • Type: Number
  • Status: Optional
 The maximum number of pages in the response.
page
  • Type: Number
  • Status: Optional
 The number of pages.
quotes
  • Type: Array of Objects
  • Status: Required
 Groups information about the quote. For more information about these fields, see the table below.
summary
  • Type: Object
  • Status: Required
 Groups summary information about the quotes.
summary.AvgQuoteValue
  • Type: String
  • Status: Optional
 The average value of the quote.
summary.totalQuotes
  • Type: Number
  • Status: Optional
 The total number of quotes.
summary.totalValue
  • Type: String
  • Status: Optional
 The total value of the quotes.
total
  • Type: Number
  • Status: Optional
 The total number of quotes.
totalPages
  • Type: Number
  • Status: Optional
 The total number of pages.

The following table displays the fields that are available in the quotes array:

Table 3. quote fields
Response Parameter Details Description
createdAt
  • Type: String
  • Status: Required
 The timestamp for when the quote was created.
customsProvider
  • Type: String
  • Status: Required
  • Required Value: "hurricane"
 The customs provider that was used to help provide the quote.
id
  • Type: Number
  • Status: Required
 The unique ID used to identify the quote.
quoteData
  • Type: Object
  • Status: Required
 The information contained in the quote for things like tax calculations, shipping rates and compliance information.
requestSource
  • Type: String
  • Status: Required
  • Required Values: "apicall" or "wordpress"
 The origin of the request. For example, from an API call or from WooCommerce.
sessionId
  • Type: String
  • Status: Required
 The Session ID fo the quote.
shippingProvider
  • Type: String
  • Status: Required
  • Required Values: "sendcloud", shipengine, "shippo" or "none"
 The name of the shipping providcr used to help generate the quote.
taxProvider
  • Type: String
  • Status: Required
  • Required Value: "hurricane"
 The name of the tax provider. Specify "hurricane".
totalAmount
  • Type: Number
  • Status: Required
 The total amount from the quote. This includes tax and shipping.
transactionValue
  • Type: Object or none
  • Status: Required
 The breakdown of the transaction's value.
updatedAt
  • Type: Date-Time string
  • Status: Required
 The timestamp for the last update.
user
  • Type: Date-Time string
  • Status: Required
 The user who created the quote.

Example Response

The following is an example of a successfule response:
{
  "quotes": [
    {
      "id": 0,
      "sessionId": "string",
      "user": {},
      "taxProvider": "hurricane",
      "shippingProvider": "sendcloud",
      "customsProvider": "hurricane",
      "requestSource": "api_call",
      "totalAmount": 0,
      "transactionValue": {},
      "quoteData": {},
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "page": 0,
  "limit": 0,
  "totalPages": 0,
  "summary": {
    "totalQuotes": 0,
    "totalValue": "string",
    "avgQuoteValue": "string"
  }
}