Get quotes by session ID

Use this request to retrieve a quote using a specified Session ID.

To retrieve a quote by using a Session ID , use the following URL:
{api_url}/quotes/{session_id}
where:
  • {api_url} is the API URL. This is usually for sandbox or production.
  • {session_id} is the ID for the session where the quote resides. This can be retrieved from the session_Id field that was returned when the quote was created.
For example, you would use the following URL to do so in the production environment
https://api.epalglobal.co/quotes/{sessionId}

Details

Table 1. Request Details
Detail
Operation GET
Endpoint
Fields Query parameters and response fields

Query Parameter

Table 2.
Query Parameter Details Description
sessionID
  • Type: String
  • Status: Required
 The ID of the quote's session. Use this to specify the quote that you want to retrieve. You can find it in the sessionID field in the original quote's response.

Response Parameters

The response contains the following fields which belong to the quote 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 response:
{
  "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"
}