negotiableQuotes query
The negotiableQuotes
query returns a list of negotiable quotes that can be viewed by the logged-in customer, including quotes created by the customer or by subordinates in the company hierarchy.
This query requires a valid customer authentication token.
Syntax
1
2
3
4
5
6
7
{
negotiableQuotes(
filter: NegotiableQuoteFilterInput,
pageSize: Int = 20,
currentPage: Int = 1
): NegotiableQuotesOutput
}
Example usage
The following example returns general information about the negotiable quotes containing the string request
that are accessible to the company user. The results are sorted by negotiable quote name, listed in ascending order.
Request:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
query {
negotiableQuotes(filter: { name:
{ match: "request" }
})
{
items {
uid
name
created_at
status
}
total_count
}
}
Response:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"data": {
"negotiableQuotes": {
"items": [
{
"uid": "BfYWqXwmUpL2Ra1igfrv6xyOMx89sFDu",
"name": "Last request",
"created_at": "2021-04-28 15:43:09",
"status": "PENDING"
},
{
"uid": "eywCZkG8avwW1eivuahc7oukY0ZFDC3H",
"name": "Latest request",
"created_at": "2021-04-26 16:35:48",
"status": "OPEN"
},
{
"uid": "xCA4wSZEHsb5QbFiKfoq5k1Dk8vIPBgb",
"name": "April 22 request",
"created_at": "2021-04-22 15:59:47",
"status": "PENDING"
},
{
"uid": "kw6mLEvl6vjjPNsjtJqwpamv5o0iT1bc",
"name": "Discount request",
"created_at": "2021-04-20 19:01:38",
"status": "ORDERED"
}
],
"total_count": 4
}
}
}
Input attributes
The negotiableQuotes
query can take the following arguments.
Attribute | Data Type | Description |
---|---|---|
currentPage |
Int | Specifies which page of results to return. The default value is 1 |
filter |
NegotiableQuoteFilterInput | Defines a filter for narrowing the query results |
pageSize |
Int | Specifies the maximum number of results to return at once. Defaults to 20 |
sort |
NegotiableQuoteSortInput | Specifies how to sort the results |
NegotiableQuoteFilterInput attributes
The NegotiableQuoteFilterInput
object defines the filter to use to return a list of negotiable quotes.
Attribute | Data Type | Description |
---|---|---|
ids |
FilterEqualTypeInput | Filter by the ID of one or more negotiable quotes |
name |
FilterMatchTypeInput | Filter by the negotiable quote name |
FilterEqualTypeInput attributes
Use the FilterEqualTypeInput
object to construct a filter that returns values that are equal to the specified string or are in an array of values.
Attribute | Data Type | Description |
---|---|---|
eq |
String | A string to filter on |
in |
[String] | An array of values to filter on |
FilterMatchTypeInput attributes
Use the FilterMatchTypeInput
object to construct a filter that returns products that exactly match a string or contain the specified pattern.
Attribute | Data Type | Description |
---|---|---|
match |
String | One or more words to filter on |
NegotiableQuoteSortInput attributes
Attribute | Data Type | Description |
---|---|---|
sort_field |
NegotiableQuoteSortableField! | CREATED_AT (default), QUOTE_NAME, or UPDATED_AT |
sort_direction |
SortEnum! | ASC or DESC (default) |
Output attributes
The NegotiableQuotesOutput
object contains the following attributes.
Attribute | Data Type | Description |
---|---|---|
items |
[NegotiableQuote]! | A list of negotiable quotes |
page_info |
SearchResultPageInfo! | Contains pagination metadata |
sort_fields |
SortFields | Contains the default sort field and all available sort fields. |
total_count |
Int! | The number of negotiable quotes returned |
NegotiableQuote attributes
The NegotiableQuote
object contains details of a negotiable quote, including its status, contents, and history.
Attribute | Data Type | Description |
---|---|---|
available_payment_methods |
[AvailablePaymentMethod] | An array of payment methods that can be applied to the negotiable quote |
billing_address |
NegotiableQuoteBillingAddress | The billing address applied to the negotiable quote |
buyer |
NegotiableQuoteUser! | The first and last name of the buyer |
comments |
[NegotiableQuoteComment!] | A list of comments made by the buyer and seller |
created_at |
String | Timestamp indicating when the negotiable quote was created |
email String |
The email address of the company user | |
history |
[NegotiableQuoteHistoryEntry!] | A list of status and price changes for the negotiable quote |
is_virtual |
Boolean | Indicates whether the negotiable quote contains only virtual products |
items |
[CartItemInterface] | The list of items in the negotiable quote |
name |
String! | The title assigned to the negotiable quote |
prices |
CartPrices | A set of subtotals and totals applied to the negotiable quote |
selected_payment_method |
SelectedPaymentMethod | The payment method that was applied to the negotiable quote |
shipping_addresses |
[NegotiableQuoteShippingAddress]! | A list of shipping addresses applied to the negotiable quote. |
status |
NegotiableQuoteStatus! | The status of the negotiable quote. Possible values are SUBMITTED, PENDING, UPDATED, OPEN, ORDERED, CLOSED, DECLINED, and EXPIRED |
total_quantity |
Float! | The total number of items in the negotiable quote |
uid |
ID! | The unique ID of a NegotiableQuote object |
updated_at |
String | Timestamp indicating when the negotiable quote was updated |
NegotiableQuoteComment attributes
The NegotiableQuoteComment
object contains details about a single comment made by the seller or the buyer.
Attribute | Data Type | Description |
---|---|---|
author |
NegotiableQuoteUser! | The first and last name of the commenter |
created_at |
String! | Timestamp indicating when the comment was created |
creator_type |
NegotiableQuoteCommentCreatorType! | Indicates whether a buyer or seller commented |
text |
String! | The plain text comment |
uid |
ID! | The unique ID of a NegotiableQuoteComment object |
NegotiableQuoteCustomLogChange attributes
The NegotiableQuoteCustomLogChange
object contains changes to a negotiable quote that were made by a third-party extension.
Attribute | Data Type | Description |
---|---|---|
new_value | String! | The new entry content |
old_value | String | The previous entry in the custom log |
title | String! | The title of the custom log entry |
NegotiableQuoteHistoryChanges attributes
The NegotiableQuoteHistoryChanges
object contains details about a single change in the history of a negotiable quote.
Attribute | Data Type | Description |
---|---|---|
comment_added |
NegotiableQuoteHistoryCommentChange | The comment provided with a change in the negotiable quote history |
custom_changes |
NegotiableQuoteCustomLogChange | Lists log entries added by third-party extensions |
expiration |
NegotiableQuoteHistoryExpirationChange | The expiration date of the negotiable quote before and after a change in the quote history |
products_removed |
NegotiableQuoteHistoryProductsRemovedChange | Lists products that were removed as a result of a change in the quote history |
statuses |
NegotiableQuoteHistoryStatusesChange | The status before and after a change in the negotiable quote history |
total |
NegotiableQuoteHistoryTotalChange | The total amount of the negotiable quote before and after a change in the quote history |
NegotiableQuoteHistoryCommentChange attributes
The NegotiableQuoteHistoryCommentChange
object contains a plain-text comment.
Attribute | Data Type | Description |
---|---|---|
comment |
String! | A simple (non-HTML) comment submitted by a seller or buyer |
NegotiableQuoteHistoryEntry attributes
The NegotiableQuoteHistoryEntry
object contains details about a change to a negotiable quote, including all previous changes made at that point.
Attribute | Data Type | Description |
---|---|---|
author |
NegotiableQuoteUser! | The person who made a change in the status of the negotiable quote |
change_type |
NegotiableQuoteHistoryEntryChangeType! | An enum that describes why the entry in the negotiable quote history changed status. Possible values are CREATED, UPDATED, CLOSED, and UPDATED_BY_SYSTEM |
changes |
NegotiableQuoteHistoryChanges | The set of changes in the negotiable quote |
created_at |
String | Timestamp indicating when the negotiable quote entry was created |
uid |
ID! | The unique ID of a NegotiableQuoteHistoryEntry object |
NegotiableQuoteHistoryExpirationChange attributes
The NegotiableQuoteHistoryExpirationChange
object lists the current expiration date of the negotiable quote, and the previous expiration date, if applicable.
Attribute | Data Type | Description |
---|---|---|
new_expiration |
String! | The expiration date after the change |
old_expiration |
String | The previous expiration date. The value will be ‘null’ if not previously set |
NegotiableQuoteHistoryProductsRemovedChange attributes
The NegotiableQuoteHistoryProductsRemovedChange
object provides details about products removed from a negotiable quote because of an action by a buyer or seller, or because the item was removed from the catalog.
Attribute | Data Type | Description |
---|---|---|
products_removed_from_catalog |
[ID] | A list of product IDs the seller removed from the catalog |
products_removed_from_quote |
[ProductInterface] | A list of products removed from the quote by either the buyer or the seller |
NegotiableQuoteHistoryStatusChange attributes
The NegotiableQuoteHistoryStatusChange
object returns the status changes during the quote’s life cycle.
Attribute | Data Type | Description |
---|---|---|
new_status |
NegotiableQuoteStatus! | The updated status |
old_status |
NegotiableQuoteStatus | The previous status. The value will be null for the first history entry in a negotiable quote |
NegotiableQuoteHistoryStatusesChange attributes
The NegotiableQuoteHistoryStatusesChange
object contains an array of all previous modifications to the negotiable quote.
Attribute | Data Type | Description |
---|---|---|
changes |
[NegotiableQuoteHistoryStatusChange!]! | A list of status changes |
NegotiableQuoteHistoryTotalChange attributes
The NegotiableQuoteHistoryTotalChange
object contains the new total price of a negotiable quote after some change has been applied.
Attribute | Data Type | Description |
---|---|---|
new_price |
Money | The total price as a result of the change |
old_price |
Money | The previous total price on the negotiable quote |
NegotiableQuoteUser attributes
The NegotiableQuoteUser
contains the first and last name of a buyer or seller.
Attribute | Data Type | Description |
---|---|---|
firstname |
String! | The first name of the buyer or seller making a change |
lastname |
String! | The buyer’s or seller’s last name |