Quote SPI

GET Get Quote Details

GET /merchant/spi/sample/endpoint/quote/{quoteId}

Operation ID: getQuoteDetails. Tags: Quote SPI.

Retrieve detailed information for a specific quote from the merchant's external ERP system. This API is called when a store associate views or resumes a specific quote in POS.

Use Cases

  • View complete quote details including items, pricing, and customer information
  • Resume a quote to cart for editing or conversion to order
  • Retrieve quote information for reporting or analysis

Request Parameters

  • quoteId: The ID of the quote to retrieve (required, path parameter)

Response (GetQuoteResponse):

  • quote: SavedCart object containing complete quote details
  • quoteId: Unique quote identifier
  • externalQuoteId: External system quote ID if different
  • customerId: Associated customer ID
  • status: Quote status (e.g., Suspended, Active)
  • cartItemList: List of items in the quote
  • subTotal: Subtotal amount
  • tax: Tax amount
  • total: Total amount
  • createdTs: Quote creation timestamp
  • source: Origin of the quote (e.g., "external", "pos")
  • associateSessionId: Session identifier for the associate

Example Response:

{
"status": "success",
"quote": {
"quoteId": "Q-001",
"externalQuoteId": "EXT-Q-001",
"customerId": "CUST-123",
"status": "Suspended",
"source": "external",
"cartItemList": [
{
"productId": "PROD-456",
"quantity": 2,
"price": 49.99
}
],
"subTotal": 99.98,
"tax": 8.00,
"total": 107.98,
"createdTs": 1701619200000
},
"associateSessionId": "session-123"
}
.

Parameters

  • quoteId (path, string, required)

Responses

  • default default response.

    Media type: application/json. Schema: SpiGetQuoteResponse.