/
Retrieve a quote

Retrieve a quote
Experimental

Request

Retrieves a quote with a specified ID.

Security
CustomerJWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

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

Headers
Acceptstring

Type of response media.

Default:"application/json"
Enum:"application/json""application/pdf"
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/quotes/{id}?expand=string' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Quote retrieved.

Body
idstring, <= 50 charactersread-only

ID of the quote.

Example:"qt_01HXBZMEGPETPHJZH6V4RHBMA8"
typestring

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

Value:"creation"
Example:"creation"
Discriminator
acceptanceFulfillmentArray of objectsread-only

List of acceptanceConditions with fulfillment status.

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)

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)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
orderobject

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)
_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
{
  "id": "qt_01HXBZMEGPETPHJZH6V4RHBMA8",
  "type": "creation",
  "acceptanceFulfillment": [
    { … }
  ],
  "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
  "status": "draft",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "order": {
    "id": "ord_01HVKA5975PJBSQ1SX72G3MSZC",
    "items": [ … ],
    "autopay": false,
    "shipping": { … },
    "deliveryAddress": { … },
    "billingAddress": { … },
    "startTime": "2019-08-24T14:15:22Z",
    "isLegacy": true
  },
  "invoicePreview": {
    "currency": "USD",
    "initialAmounts": { … },
    "recurringAmounts": { … },
    "items": [ … ]
  },
  "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": {
    "showWrittenSignatureLines": false,
    "organizationPrintedName": null
  },
  "tax": {
    "calculator": "manual",
    "amount": 0.1,
    "items": [ … ]
  },
  "_links": [
    { … }
  ],
  "_embedded": {
    "customer": {},
    "creditMemos": [ … ],
    "website": {},
    "order": {},
    "invoice": {}
  }
}