Use these operations to access Storefront quotes.
Storefront operations interact directly with the customer, and provide the customer with access to their own data.
To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see Create a session with username and password and Exchange an authentication token. Storefront operations are intended to be used directly from an untrusted browser.
Retrieves a quote with a specified ID.
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.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/storefront/quotes/{id}
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/storefront/quotes/{id}
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/storefront/quotes/{id}
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>'Quote retrieved.
Type of the quote. When a quote is accepted, a new order is created.
ID of the payment invoice.
Status of the quote.
| Enum Value | 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 or customer canceled the quote. |
| expired | Expired before customer or organization interaction. |
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
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.
Date and time when the resource is created. This value is set automatically when the resource is created.
Date and time when the resource is updated. This value is set automatically when the resource is updated.
URL to redirect the customer to when a quote is rejected. The default value is the website URL.
- application/json
- application/pdf
- create
- change
- reactivate
{ "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": {} } }