---
title: List Quotes
slug: api-documentation/list-quotes
createdAt: 2026-11-19T10:36:23.437Z
---

{
  "id": "LOK58ymEEiayg7t3uwqwq",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.upstartcommerce.com/v1/quote",
    "servers": [
      {
        "url": "https://api.upstartcommerce.com/v1/quote"
      }
    ],
    "name": "List Quotes",
    "description": "<p>This endpoint lists one page of the quotes of the site in <code>x-upstart-site</code>, for the Admin UI quotes list.\nIt replaces the search route <code>quote</code>.</p>\n<p>Authorized permissions:</p>\n<ul>\n<li><code>quote.read</code></li>\n</ul>\n<p>Search (<code>query</code>): words are OR'ed (<code>*</code> is ignored; beyond 10 words only the first 9 and the last are used);\nevery word but the last must equal a whole word, the last may be the start of a word; case-insensitive; words split on punctuation; a word may also be\nthe start of a whole value (e.g. <code>john.smith@ex</code>). Searched: id, externalId, siteId, storeLocationId,\ncurrency, customer name, email and shipping address, sales associate, item ids and pricing.</p>\n<p>Sort (<code>sort</code>, repeatable, applied in request order, then <code>id</code> descending): <code>id</code>, <code>storeLocationId</code>,\n<code>customerLastName</code>, <code>quantity</code>, <code>createdAt</code> with optional <code>:asc</code> (default) or <code>:desc</code>, and <code>relevance</code>\n(descending only: more matched words first, then newest). <code>storeLocationId</code> and <code>customerLastName</code> compare\nbytes, a missing last name is last; <code>quantity</code> uses the smallest item quantity ascending and the largest\ndescending, quotes without items last. Default <code>createdAt:desc</code>.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        },
        {
          "kind": "required",
          "name": "x-upstart-tenant",
          "type": "string",
          "description": "Tenant identifier associated with the site this call is for."
        },
        {
          "kind": "optional",
          "name": "x-upstart-site",
          "type": "string",
          "description": "Unique identifier for the site."
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "query",
          "type": "string",
          "description": "<p>Free-text search; see the operation description.</p>"
        },
        {
          "kind": "optional",
          "name": "page",
          "type": "string",
          "description": "<p>Zero-based page number. Default 0.</p>"
        },
        {
          "kind": "optional",
          "name": "pageSize",
          "type": "string",
          "description": "<p>Quotes per page, 1-100. Default 25.</p>"
        },
        {
          "kind": "optional",
          "name": "sort",
          "type": "array",
          "description": "<p><code>&#x3C;property>[:asc|:desc]</code>, repeatable. Properties: id, storeLocationId, customerLastName, quantity, createdAt, relevance.</p>",
          "schema": [],
          "itemType": "string",
          "customType": "string[]"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "NoChannelPortalAccess",
          "name": "NoChannelPortalAccess",
          "kind": "optional",
          "type": "http",
          "description": "<p>This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "One page of quotes and the number of matches before paging.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "One page of the site's quotes and the number of matches before paging.",
            "customType": "QuoteList",
            "schema": [
              {
                "name": "items",
                "kind": "required",
                "type": "object",
                "description": "<p>A sales quote, with its identifiers and current state alongside the common quote fields.</p>",
                "modelRef": "#/components/schemas/Quote",
                "customType": "Quote[]",
                "complexType": "allOf",
                "complexItems": [
                  {
                    "name": "BaseQuote",
                    "description": "",
                    "modelRef": "#/components/schemas/BaseQuote",
                    "schema": [
                      {
                        "name": "customer",
                        "kind": "required",
                        "type": "object",
                        "description": "<p>The customer a quote is prepared for, with their name, email and shipping address.</p>",
                        "modelRef": "#/components/schemas/Customer",
                        "customType": "Customer",
                        "schema": [
                          {
                            "name": "name",
                            "kind": "optional",
                            "type": "object",
                            "description": "<p>A person's name, broken into salutation, first, middle initial, last and suffix.</p>",
                            "modelRef": "#/components/schemas/Name",
                            "customType": "Name",
                            "schema": [
                              {
                                "name": "first",
                                "kind": "required",
                                "type": "string",
                                "description": "The first name of the individual being addressed.",
                                "example": "John"
                              },
                              {
                                "name": "last",
                                "kind": "required",
                                "type": "string",
                                "description": "The last name of the individual being addressed.",
                                "example": "Smith"
                              },
                              {
                                "name": "middleInitial",
                                "kind": "optional",
                                "type": "string",
                                "description": "The middle initial of the individual being addressed.",
                                "example": "D."
                              },
                              {
                                "name": "salutation",
                                "kind": "optional",
                                "type": "string",
                                "description": "The salutation of the individual being addressed.",
                                "example": "Capt."
                              },
                              {
                                "name": "suffix",
                                "kind": "optional",
                                "type": "string",
                                "description": "The optional suffix of the individual being addressed.",
                                "example": "Sr."
                              }
                            ]
                          },
                          {
                            "name": "email",
                            "kind": "optional",
                            "type": "string<email>",
                            "description": "",
                            "format": "email"
                          },
                          {
                            "name": "shippingAddress",
                            "kind": "optional",
                            "type": "object",
                            "description": "Standardized format for global addresses.",
                            "modelRef": "#/components/schemas/Address",
                            "customType": "Address",
                            "schema": [
                              {
                                "name": "street1",
                                "kind": "required",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "street2",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "city",
                                "kind": "required",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "county",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "stateOrRegion",
                                "kind": "required",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "country",
                                "kind": "required",
                                "type": "string",
                                "description": "Defaults to US.",
                                "minLength": 2,
                                "maxLength": 2
                              },
                              {
                                "name": "postalCode",
                                "kind": "required",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "poBox",
                                "kind": "optional",
                                "type": "boolean",
                                "description": ""
                              },
                              {
                                "name": "name",
                                "kind": "optional",
                                "type": "object",
                                "description": "<p>A person's name, broken into salutation, first, middle initial, last and suffix.</p>",
                                "modelRef": "#/components/schemas/Name",
                                "customType": "Name",
                                "schema": [
                                  {
                                    "name": "first",
                                    "kind": "required",
                                    "type": "string",
                                    "description": "The first name of the individual being addressed.",
                                    "example": "John"
                                  },
                                  {
                                    "name": "last",
                                    "kind": "required",
                                    "type": "string",
                                    "description": "The last name of the individual being addressed.",
                                    "example": "Smith"
                                  },
                                  {
                                    "name": "middleInitial",
                                    "kind": "optional",
                                    "type": "string",
                                    "description": "The middle initial of the individual being addressed.",
                                    "example": "D."
                                  },
                                  {
                                    "name": "salutation",
                                    "kind": "optional",
                                    "type": "string",
                                    "description": "The salutation of the individual being addressed.",
                                    "example": "Capt."
                                  },
                                  {
                                    "name": "suffix",
                                    "kind": "optional",
                                    "type": "string",
                                    "description": "The optional suffix of the individual being addressed.",
                                    "example": "Sr."
                                  }
                                ]
                              },
                              {
                                "name": "businessName",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "phoneNumber",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "salesAssociate",
                        "kind": "required",
                        "type": "object",
                        "description": "The sales associate who prepared the quote.",
                        "modelRef": "#/components/schemas/SalesAssociate",
                        "customType": "SalesAssociate",
                        "schema": [
                          {
                            "name": "id",
                            "kind": "required",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "name",
                            "kind": "optional",
                            "type": "object",
                            "description": "<p>A person's name, broken into salutation, first, middle initial, last and suffix.</p>",
                            "modelRef": "#/components/schemas/Name",
                            "customType": "Name",
                            "schema": [
                              {
                                "name": "first",
                                "kind": "required",
                                "type": "string",
                                "description": "The first name of the individual being addressed.",
                                "example": "John"
                              },
                              {
                                "name": "last",
                                "kind": "required",
                                "type": "string",
                                "description": "The last name of the individual being addressed.",
                                "example": "Smith"
                              },
                              {
                                "name": "middleInitial",
                                "kind": "optional",
                                "type": "string",
                                "description": "The middle initial of the individual being addressed.",
                                "example": "D."
                              },
                              {
                                "name": "salutation",
                                "kind": "optional",
                                "type": "string",
                                "description": "The salutation of the individual being addressed.",
                                "example": "Capt."
                              },
                              {
                                "name": "suffix",
                                "kind": "optional",
                                "type": "string",
                                "description": "The optional suffix of the individual being addressed.",
                                "example": "Sr."
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "currency",
                        "kind": "required",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "items",
                        "kind": "required",
                        "type": "array",
                        "description": "<p>A line on a quote: the catalog item and SKU quoted, its quantity and pricing, and any validation messages raised against it.</p>",
                        "modelRef": "#/components/schemas/QuoteItem",
                        "customType": "QuoteItem[]",
                        "schema": [
                          {
                            "name": "catalogItemId",
                            "kind": "optional",
                            "type": "string",
                            "description": ""
                          },
                          {
                            "name": "skuId",
                            "kind": "required",
                            "type": "string",
                            "description": "Identifier of a specific SKU of a catalog item.",
                            "modelRef": "#/components/schemas/SkuId",
                            "customType": "SkuId",
                            "schema": []
                          },
                          {
                            "name": "targetItemIds",
                            "kind": "optional",
                            "type": "array",
                            "description": "<p>Target items are SKU ids / references to products from warranties and protection plans. Products are not allowed to have targetItems, warranty and protection plan must reference one or more products.</p>",
                            "modelRef": "#/components/schemas/SkuId",
                            "customType": "SkuId[]",
                            "schema": []
                          },
                          {
                            "name": "quantity",
                            "kind": "required",
                            "type": "integer",
                            "description": ""
                          },
                          {
                            "name": "pricing",
                            "kind": "optional",
                            "type": "object",
                            "description": "<p>The price of a quoted item for a pricing type and zone, with its list price.</p>",
                            "modelRef": "#/components/schemas/QuoteItemPrice",
                            "customType": "QuoteItemPrice",
                            "schema": [
                              {
                                "name": "type",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "zone",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "price",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              },
                              {
                                "name": "listPrice",
                                "kind": "optional",
                                "type": "string",
                                "description": ""
                              }
                            ]
                          },
                          {
                            "name": "inStorePickUp",
                            "kind": "optional",
                            "type": "boolean",
                            "description": "Defines if preferred shipping method should be in store pick up",
                            "default": false
                          },
                          {
                            "name": "validationMessages",
                            "kind": "optional",
                            "type": "array",
                            "description": "This details any validation issues that there on the quote.",
                            "modelRef": "#/components/schemas/QuoteValidationMessage",
                            "customType": "QuoteValidationMessage[]",
                            "schema": [
                              {
                                "name": "detail",
                                "kind": "optional",
                                "type": "string",
                                "description": "This is a message specific to this error. It is not intended for display to the user."
                              },
                              {
                                "name": "level",
                                "kind": "required",
                                "type": "string",
                                "description": "<p>Severity of a quote validation message: INFO for advisory, WARN for a condition needing attention.</p>",
                                "modelRef": "#/components/schemas/QuoteValidationMessageLevel",
                                "customType": "QuoteValidationMessageLevel",
                                "schema": []
                              },
                              {
                                "name": "message",
                                "kind": "optional",
                                "type": "string",
                                "description": "Basic error message."
                              },
                              {
                                "name": "code",
                                "kind": "required",
                                "type": "string",
                                "description": "Set of quote validation codes.",
                                "modelRef": "#/components/schemas/QuoteValidationMessageCode",
                                "customType": "QuoteValidationMessageCode",
                                "schema": []
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "storeLocationId",
                        "kind": "required",
                        "type": "string",
                        "description": "Unique identifier for a store's location."
                      }
                    ]
                  },
                  {
                    "name": "object",
                    "description": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "required",
                        "type": "integer<int64>",
                        "description": "Unique identifier for a quote.",
                        "format": "int64"
                      },
                      {
                        "name": "siteId",
                        "kind": "required",
                        "type": "string",
                        "description": "Identifier of the site a quote belongs to.",
                        "modelRef": "#/components/schemas/SiteId",
                        "customType": "SiteId",
                        "schema": []
                      },
                      {
                        "name": "createdAt",
                        "kind": "required",
                        "type": "string<date-time>",
                        "description": "",
                        "format": "date-time"
                      },
                      {
                        "name": "expiresAt",
                        "kind": "optional",
                        "type": "string<date>",
                        "description": "",
                        "format": "date"
                      },
                      {
                        "name": "externalId",
                        "kind": "required",
                        "type": "string",
                        "description": "Unique identifier for an external quote."
                      },
                      {
                        "name": "archivedItems",
                        "kind": "required",
                        "type": "array",
                        "description": "<p>Contains archived items excluded from <code>items</code>.</p>",
                        "example": "",
                        "default": [],
                        "itemType": "string",
                        "customType": "string[]",
                        "itemExample": "",
                        "itemDefault": ""
                      }
                    ]
                  }
                ],
                "schema": []
              },
              {
                "name": "total",
                "kind": "required",
                "type": "integer<int32>",
                "description": "Number of quotes matching the request before paging.",
                "format": "int32"
              },
              {
                "name": "page",
                "kind": "required",
                "type": "integer<int32>",
                "description": "",
                "format": "int32"
              },
              {
                "name": "pageSize",
                "kind": "required",
                "type": "integer<int32>",
                "description": "",
                "format": "int32"
              }
            ],
            "modelRef": "#/components/schemas/QuoteList",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Error payload returned when a request fails validation, identifying the offending input by name, code and detail.</p>",
            "customType": "ValidationErrorResponse",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "code",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "detail",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/ValidationErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.</p>",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "name",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "code",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "detail",
                "kind": "required",
                "type": "string",
                "description": ""
              },
              {
                "name": "reason",
                "kind": "optional",
                "type": "string",
                "description": ""
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.upstartcommerce.com/v1/quote \\\n     --header 'accept: application/json' \\\n     --header 'x-upstart-tenant: string'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/quote\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/quote\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/quote\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// One page of quotes and the number of matches before paging.\n{\n  \"items\": {},\n  \"total\": \"\",\n  \"page\": \"\",\n  \"pageSize\": \"\"\n}"
        },
        {
          "id": "response-1-400",
          "language": "400",
          "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n  \"name\": \"\",\n  \"code\": \"\",\n  \"detail\": \"\"\n}"
        },
        {
          "id": "response-2-401",
          "language": "401",
          "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n  \"name\": \"\",\n  \"code\": \"\",\n  \"detail\": \"\",\n  \"reason\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}