Quote API
The Quote APIs allow the developer to manage information about a quote, such as the store details, the quote line items, and price amounts
Index
Representations
All requests or responses are JSON objects.
Quote
storeName - string - The store name.
salesPerson_name - string - The Salesperson’s name.
address - Address - The address is saved as an array.
customerId - string - The TWC internal identifier for the customer who belongs to the quote.
customerRef - string - The retailer’s own customer identifier for the customer who belongs to the quote.
firstName - string - The customer’s first name.
lastName - string - The customer’s last name.
email - string - The customer’s email address.
referenceNo - string - The reatiler’s refernce number for the quote.
expiryDate - The expiry date of the quote. The date and time are in ISO 8601 format.
totalQuoteAmount - decimal - Total quote amount.
totalDiscount - decimal - Total discount amount.
externalNotes - string - Quote notes with time stamp.
createdAt - The date and time (ISO 8601 format) for when quote was created.
id - string - TWC’s unique identifier for the quote.
updatedAt - The date and time (ISO 8601 format) when the quote information was last updated.
deleted - boolean - Indicates the quote is deleted.
locationId - string - The store location id (TWC identifier).
locationRef - string - The store location ref (retailer’s own identifier).
quoteTax - decimal - The quote tax amount.
salesPerson_code - string - Salesperson code.
number_of_lines - ineteger - The number of lines in the quote.
status - string - The quote status
purchased - boolean - Indicated the quote converted into order
attributeGroups - AttributeGroup - A group of additional attibutes available to the retailer and stored as an object under atributeGroups.
Quote line
quoteId - string - The unique TWC internal quote identifier.
productCode - string - The retailer’s code for the product on this line item.
productDescription - string - The description of the product on this line item.
quantity - string - The quantity of the product for this line item.
unitPrice - decimal - The product’s unit price
unitDiscount - decimal - discount amount.
subTotal - decimal - final amount after deducting the discount
promotion - boolean - Indicates if there is a promotion on this line item.
createdAt - The date and time (ISO 8601 format) when the quote line item was created.
id - string - TWC’s unique identifier for the quote line item.
updatedAt - The date and time (ISO 8601 format) when the quote line item information was last updated.
deleted - boolean - Indicates if the quote line is deleted.
discountCode - string - The discount code.
voided - boolean - Indicates the quote is voided.
discountTotal - decimal - The total discount for this quote line.
rrp - decimal - The recommended retail price for the item on this quote line.
lineNumber - string - unique number of quote line
attributeGroups - AttributeGroup - A group of additional attibutes available to the retailer and stored as an object under atributeGroups.
REST Endpoints
-
Quote
Create a Quote
Creates a new Quote data set in the TWC system.
Endpoint: /api/v1/quote
Method: POST
Method Name: createQuote
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
{
"address": {
"address1": "string",
"address2": "string",
"addressId": "string",
"addressRef": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"province": "string",
"provinceCode": "string"
},
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T08:59:08.903Z",
"customerId": "string",
"customerRef": "string",
"expiryDate": "2023-05-25T08:59:08.903Z",
"externalNotes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"id": "string",
"lineItems": [
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T08:59:08.903Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T08:59:08.903Z",
"voided": true
}
],
"locationId": "string",
"locationRef": "string",
"number_of_lines": 0,
"quoteTax": 0,
"referenceNo": "string",
"salesPerson_code": "string",
"salesPerson_name": "string",
"status": "string",
"totalDiscount": 0,
"totalQuoteAmount": 0,
"updatedAt": "2023-05-25T08:59:08.903Z"
}
{
"address": {
"address1": "string",
"address2": "string",
"addressId": "string",
"addressRef": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"province": "string",
"provinceCode": "string"
},
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T08:59:08.903Z",
"customerId": "string",
"customerRef": "string",
"expiryDate": "2023-05-25T08:59:08.903Z",
"externalNotes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"id": "string",
"lineItems": [
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T08:59:08.903Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T08:59:08.903Z",
"voided": true
}
],
"locationId": "string",
"locationRef": "string",
"number_of_lines": 0,
"quoteTax": 0,
"referenceNo": "string",
"salesPerson_code": "string",
"salesPerson_name": "string",
"status": "string",
"totalDiscount": 0,
"totalQuoteAmount": 0,
"updatedAt": "2023-05-25T08:59:08.903Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update a Quote
Updates an existing Quote data set in the TWC platform.
Endpoint: /api/v1/quote
Method: PUT
Method Name: updateQuote
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
{
"address": {
"address1": "string",
"address2": "string",
"addressId": "string",
"addressRef": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"province": "string",
"provinceCode": "string"
},
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"customerId": "string",
"customerRef": "string",
"expiryDate": "2023-05-25T09:02:00.752Z",
"externalNotes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"id": "string",
"locationId": "string",
"locationRef": "string",
"number_of_lines": 0,
"quoteTax": 0,
"referenceNo": "string",
"salesPerson_code": "string",
"salesPerson_name": "string",
"status": "string",
"totalDiscount": 0,
"totalQuoteAmount": 0,
"updatedAt": "2023-05-25T09:02:00.752Z"
}
{
"address": {
"address1": "string",
"address2": "string",
"addressId": "string",
"addressRef": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"province": "string",
"provinceCode": "string"
},
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:02:00.770Z",
"customerId": "string",
"customerRef": "string",
"deleted": true,
"email": "string",
"expiryDate": "2023-05-25T09:02:00.770Z",
"externalNotes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"firstName": "string",
"id": "string",
"lastName": "string",
"lineItems": [
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:02:00.770Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:02:00.770Z",
"voided": true
}
],
"locationId": "string",
"locationRef": "string",
"number_of_lines": 0,
"quoteTax": 0,
"referenceNo": "string",
"salesPerson_code": "string",
"salesPerson_name": "string",
"status": "string",
"totalDiscount": 0,
"totalQuoteAmount": 0,
"updatedAt": "2023-05-25T09:02:00.770Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Quote by ID or Ref
Returns a quote using either it’s internal TWC identifier (ID) or the customer’s own quote reference (Ref). This returns a quote, including the quote lines.
If the quote does not exist, this method returns a 404.
Endpoint: /api/v1/quote
Method: GET
Method Name: getquote
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
Request Parameters: id : Quote Id ,Ref : Quote Reference
{
"address": {
"address1": "string",
"address2": "string",
"addressId": "string",
"addressRef": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"province": "string",
"provinceCode": "string"
},
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:04:46.766Z",
"customerId": "string",
"customerRef": "string",
"deleted": true,
"email": "string",
"expiryDate": "2023-05-25T09:04:46.766Z",
"externalNotes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"firstName": "string",
"id": "string",
"lastName": "string",
"lineItems": [
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:04:46.766Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:04:46.766Z",
"voided": true
}
],
"locationId": "string",
"locationRef": "string",
"number_of_lines": 0,
"quoteTax": 0,
"referenceNo": "string",
"salesPerson_code": "string",
"salesPerson_name": "string",
"status": "string",
"totalDiscount": 0,
"totalQuoteAmount": 0,
"updatedAt": "2023-05-25T09:04:46.766Z"
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Get Quotes By Customer Reference/Email
Returns a list of quotes using the retailer’s customer reference or email.
If the quote does not exist, this method returns a 404.
Endpoint: /api/v1/quote/customer
Method: GET
Method Name: findCustomerQuotes
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
Request Parameters: customer_ref : Customer reference, customer_email : Customer email,pageSize : no of expected quotes in a page, lastItemId: id of the last customer quote received in the page
[
[
{
"address": {
"address1": "string",
"address2": "string",
"addressId": "string",
"addressRef": "string",
"city": "string",
"company": "string",
"country": "string",
"countryCode": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"name": "string",
"phone": "string",
"postcode": "string",
"province": "string",
"provinceCode": "string"
},
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:05:25.072Z",
"customerId": "string",
"customerRef": "string",
"deleted": true,
"email": "string",
"expiryDate": "2023-05-25T09:05:25.072Z",
"externalNotes": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"firstName": "string",
"id": "string",
"lastName": "string",
"lineItems": [
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:05:25.072Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:05:25.072Z",
"voided": true
}
],
"locationId": "string",
"locationRef": "string",
"number_of_lines": 0,
"quoteTax": 0,
"referenceNo": "string",
"salesPerson_code": "string",
"salesPerson_name": "string",
"status": "string",
"totalDiscount": 0,
"totalQuoteAmount": 0,
"updatedAt": "2023-05-25T09:05:25.072Z"
}
]
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete Quote by ID
Deleting a quote marks the quote as deleted and produces the HTTP response confirming the action. Requires the TWC quote identifier.
If the quote does not exist, this method returns 404 response.
Endpoint: /api/v1/quote/{id}
Method: DELETE
Method Name: deleteQuote
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
Path Variable: ` id : quote id `
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete Quote by Ref
Deleting a quote by ref marks the quote as deleted and produces an HTTP response confirming the action. This method uses the quote reference identifier assigned by the retailer.
If the quote does not exist, this method returns 404 response.
Endpoint: /api/v2/quote/{Ref}/byref
Method: DELETE
Method Name: deleteQuoteByRef
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
Path Variable : ` Ref : quote Ref`
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
-
Quote Line
Create a Quote Line
Creates a new Quote line data set in the TWC system. Requires the TWC quote identifier.
Endpoint: /api/v1/quote/line
Method: POST
Method Name: createQuoteLine
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:06:26.394Z",
"discountCode": "string",
"discountTotal": 0,
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"quoteId": "string",
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:06:26.394Z",
"voided": true
}
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:06:26.404Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:06:26.405Z",
"voided": true
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Update a Quote Line
Updates Quote line data set. Requires the TWC quote line identifier.
Endpoint: /api/v1/quote/line
Method: PUT
Method Name: updateQuoteLine
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:07:24.464Z",
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:07:24.464Z",
"voided": true
}
{
"attributeGroups": {
"additionalProp1": {
"attribute_group": "string",
"attributes": {
"additionalProp1": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp2": {
"attribute_value": "string",
"value_type": "BLOB"
},
"additionalProp3": {
"attribute_value": "string",
"value_type": "BLOB"
}
},
"is_obsolete": true
}
},
"createdAt": "2023-05-25T09:07:24.475Z",
"deleted": true,
"discountCode": "string",
"discountTotal": 0,
"id": "string",
"lineNumber": "string",
"productCode": "string",
"productDescription": "string",
"promotion": true,
"quantity": 0,
"rrp": 0,
"subTotal": 0,
"unitDiscount": 0,
"unitPrice": 0,
"updatedAt": "2023-05-25T09:07:24.475Z",
"voided": true
}
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input
Delete Quote Line
Deleting a Quote line marks the quote line as deleted and produces an HTTP response confirming the action. Requires the TWC quote line identifier.
If the quote line does not exist, this method returns 404 response.
Endpoint: /api/v1/quote/line/{id}
Method: DELETE
Method Name: deleteQuoteLine
OAuth 2.0 Scopes: Tenant authentication - authentication
| Key | Value |
|---|---|
| Content-Type | application/json |
| X-TWC-Tenant | {Tenant Name} |
Path Variable: ` id : quote line id `
HTTP Status Code:
- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request
- 401 Unauthorised
- 403 Forbidden
- 404 Not Found
- 405 Invalid input