closeNegotiableQuotes mutation
The closeNegotiableQuotes
mutation closes an active negotiable quote. Once a quote is closed, it cannot be re-opened. Closed negotiable quotes can be viewed by the merchant and company users.
This mutation requires a valid customer authentication token.
Syntax
1
2
3
closeNegotiableQuotes(
input: CloseNegotiableQuotesInput!
): CloseNegotiableQuotesOutput
Example usage
The following example contains an invalid quote_uids
value, causing a FAILURE status.
Request:
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
mutation {
closeNegotiableQuotes(
input: {
quote_uids: ["xyz"]
}
) {
result_status,
operation_results {
...on NegotiableQuoteUidOperationSuccess{
__typename
quote_uid
}
...on CloseNegotiableQuoteOperationFailure{
__typename
quote_uid
errors {
__typename
...on ErrorInterface{
message
}
...on NoSuchEntityUidError{
uid
}
...on NegotiableQuoteInvalidStateError {
message
}
}
}
}
}
}
Response:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"data": {
"closeNegotiableQuotes": {
"result_status": "FAILURE",
"operation_results": [
{
"__typename": "CloseNegotiableQuoteOperationFailure",
"quote_uid": "xyz",
"errors": [
{
"__typename": "NoSuchEntityUidError",
"message": "Could not find a quote with the specified UID.",
"uid": "xyz"
}
]
}
]
}
}
}
Input attributes
The CloseNegotiableQuotesInput
object contains the following attribute.
Attribute | Data Type | Description |
---|---|---|
quote_item_uids |
[ID!]! | A list of unique IDs from NegotiableQuote objects |
Output attributes
The CloseNegotiableQuotesOutput
output object contains the following fields.
Attribute | Data Type | Description |
---|---|---|
closed_quotes |
[NegotiableQuote] | Deprecated. Use operation_results instead. An array containing the negotiable quotes that were just closed |
negotiable_quotes (filter NegotiableQuoteFilterInput, pageSize = 20 Int, currentPage = 1 Int) |
NegotiableQuotesOutput | A list of negotiable quotes that the customer can view |
operation_results |
[CloseNegotiableQuoteOperationResult!]! | An array of closed negotiable quote UIDs and details about any errors |
result_status |
BatchMutationStatus | The status of the request to close one or more negotiable quotes. The possible values are SUCCESS, FAILURE, and MIXED_RESULTS |
The negotiable_quotes
attribute takes 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) |
CloseNegotiableQuoteOperationResult attributes
The CloseNegotiableQuoteOperationResult
union provides details about the result of a request to close a negotiable quote. To return these details, specify fragments on the CloseNegotiableQuoteOperationFailure
and NegotiableQuoteUidOperationSuccess
objects. Specify the __typename
attribute to distinguish the object types in the response.
CloseNegotiableQuoteOperationFailure attributes
The CloseNegotiableQuoteOperationFailure type contains details about a failed close operation on a negotiable quote. It contains the following fields.
Attribute | Data Type | Description |
---|---|---|
errors |
[CloseNegotiableQuoteError!]! | An array of errors encountered while attempting close the negotiable quote |
quote_uid |
ID! | The unique ID of a NegotiableQuote object |
CloseNegotiableQuoteError attributes
The CloseNegotiableQuoteError
union type contains one or more of the following data types, all of which implement ErrorInterface
.
InternalError
NegotiableQuoteInvalidStateError
NoSuchEntityUidError
InternalError attributes
The InternalError
object contains an error message if an internal error occurred.
Attribute | Data Type | Description |
---|---|---|
message |
String! | The returned error message |
NegotiableQuoteInvalidStateError attributes
The NegotiableQuoteInvalidStateError
object contains an error message indicating that an operation was attempted on a negotiable quote in an invalid state.
Attribute | Data Type | Description |
---|---|---|
message |
String! | The returned error message |
NoSuchEntityUidError attributes
The NoSuchEntityUidError
object contains an error message when an invalid UID was specified.
Attribute | Data Type | Description |
---|---|---|
message |
String! | The returned error message |
uid |
ID! | The specified invalid unique ID of an object |
NegotiableQuoteUidOperationSuccess attributes
The NegotiableQuoteUidOperationSuccess
object contains details about a successful operation on a negotiable quote. It implements the NegotiableQuoteUidNonFatalResultInterface
, which defines the following field
Attribute | Data Type | Description |
---|---|---|
quote_uid | ID! @doc(description: “The unique ID of a NegotiableQuote object |
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 |