Quotes

Use quote operations to create and manage quotations. Quotations describe the cost of goods or services to potential customers before they commit to a purchase. A quote contains an initial invoice preview that can be accepted to become an order.

A quote can contain subscription and one-time sale items. When a quote contains one or more subscription items, it is a subscription order quote.

Operations

Retrieve quotes
Experimental

Request

Retrieves a list of quotes.

Security
SecretApiKey or JWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

expandstring

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 Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/quotes?filter=string&sort=string&limit=0&offset=0&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of quotes retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the quote.

Example:"qt_01HXBZMEGPETPHJZH6V4RHBMA8"
typestringrequired

Type of the quote. When a quote is accepted, a new order is created.

Value:"creation"
Discriminator
acceptanceFulfillmentArray of objectsread-only

List of acceptanceConditions with fulfillment status.

isNewOrderbooleanread-only

Specifies if the order is a new order.

Example:true
invoiceIdstring, <= 50 charactersread-only

ID of the payment invoice.

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
statusstringread-only

Status of the quote.

Enum ValueDescription
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 or customer canceled the quote.

expired

Expired before customer or organization interaction.

websiteIdstring, <= 50 characters(WebsiteId)required

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

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
customerIdstring, <= 50 characters(CustomerId)required

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
orderobjectrequired

Properties of the related order.

invoicePreviewobjectread-only

Preview of the quote invoice.

paymentTermsstring

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

expirationTimestring 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.

issuedTimestring or null, (date-time)read-only

Date and time when the quote is issued.

acceptedTimestring or null, (date-time)read-only

Date and time when the quote is accepted.

rejectedTimestring or null, (date-time)read-only

Date and time when the quote is rejected.

canceledTimestring or null, (date-time)read-only

Date and time when the quote is canceled.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

redirectUrlstring, (uri), <= 2083 characters

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

signatureobject

Written signature and printed organization name.

taxobject(Taxes)
couponIdsArray of strings or null

List of coupons to redeem on the customer and apply to the related invoice.

For more information, see Coupons.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "id": "qt_01HXBZMEGPETPHJZH6V4RHBMA8",
    "type": "creation",
    "acceptanceFulfillment": [ … ],
    "isNewOrder": true,
    "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
    "status": "draft",
    "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
    "order": { … },
    "invoicePreview": { … },
    "paymentTerms": "string",
    "expirationTime": "2019-08-24T14:15:22Z",
    "issuedTime": "2019-08-24T14:15:22Z",
    "acceptedTime": "2019-08-24T14:15:22Z",
    "rejectedTime": "2019-08-24T14:15:22Z",
    "canceledTime": "2019-08-24T14:15:22Z",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "redirectUrl": "http://example.com",
    "signature": { … },
    "tax": { … },
    "couponIds": [ … ],
    "_links": [ … ],
    "_embedded": { … }
  }
]