Retrieve quotes

Retrieves a list of quotes.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

List of quotes retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

required
Array of objects (QuoteItem) non-empty

Items included in the quote.

Array (non-empty)
required
OriginalPlan (object) or (FlexiblePlan (OneTimeSalePlan (object) or SubscriptionOrderPlan (object) or TrialOnlyPlan (object)))

Plan details.

quantity
required
integer >= 1

Number of product units in the specified plan.

id
string

ID of the quote item.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

object

Embedded objects that are requested by the expand query parameter.

id
string <= 50 characters

ID of the quote.

type
string

Specifies the type of quote. A quote can be a subscription or a one-time purchase.

Enum: "subscription-order" "one-time-order"
status
string

Status of the quote.

Enum: Description
draft

Quote can be edited. This quote cannot be sent to a customer.

issued

Quote cannot be edited. This quote can be sent to a customer.

accepted

Customer accepted the quote and created an order.

rejected

Customer rejected the quote.

canceled

Organization canceled the quote.

expired

Expired before customer or organization interaction.

orderId
string or null <= 50 characters

ID of the order.

object or null

Delivery address of the order.

firstName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\p{L},.'&]+$

Contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

object or null

Billing address of the order.

firstName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\p{L},.'&]+$

Contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\p{L},.#;:()'&]+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\p{L},.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\p{L},.#;:()']+$

Contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

object (QuoteInvoicePreview)

Preview of initial quote invoice.

currency
string = 3 characters

Currency of the invoice.

amount
number <double>

Amount of the invoice.

subtotalAmount
number <double>

Subtotal amount of the invoice.

discountAmount
number <double>

Discount amount that is applied to the invoice.

shippingAmount
number <double>

Shipping amount that is applied to the invoice.

taxAmount
number <double>

Tax amount that is applied to the invoice.

Array of objects (QuoteInvoicePreviewItem)

Invoice items.

paymentTerms
string

Payment terms for the customer which are displayed on the quote.

expirationTime
string or null <date-time>

Date and time when the quote expires. The default expiration time is one month from the time the quote is issued. In a draft state, this field may be null.

issuedTime
string or null <date-time>

Date and time when the quote is issued.

acceptedTime
string or null <date-time>

Date and time when the quote is accepted.

rejectedTime
string or null <date-time>

Date and time when the quote is rejected.

canceledTime
string or null <date-time>

Date and time when the quote is canceled.

redirectUrl
string <uri>

URL to redirect the customer to when a quote is rejected. The default value is the website URL.

object (QuoteSignature)
showWrittenSignatureLines
boolean
Default: false

Specifies whether to show written signature lines.

organizationPrintedName
string or null
Default: null

Printed name of the organization.

object (Shipping)

Shipping settings.

amount
required
integer

Shipping amount.

calculator
required
string

Shipping calculator.

couponIds
Array of strings or null

List of coupons to redeem on the customer and apply to the order when the quote is accepted.

For more information, see Coupons.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "quoteAcceptanceFormUrl"
object

Embedded objects that are requested by the expand query parameter.

customer
object
website
object
order
object
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/quotes
Request samples
Response samples
application/json
[
  • {
    }
]