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.

Output attributes

The CloseNegotiableQuotesOutput output object contains the following fields.

The negotiable_quotes attribute takes the following arguments.

NegotiableQuoteFilterInput attributes

The NegotiableQuoteFilterInput object defines the filter to use to return a list of negotiable quotes.

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.

FilterMatchTypeInput attributes

Use the FilterMatchTypeInput object to construct a filter that returns products that exactly match a string or contain the specified pattern.

NegotiableQuoteSortInput attributes

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.

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.

NegotiableQuoteInvalidStateError attributes

The NegotiableQuoteInvalidStateError object contains an error message indicating that an operation was attempted on a negotiable quote in an invalid state.

NoSuchEntityUidError attributes

The NoSuchEntityUidError object contains an error message when an invalid UID was specified.

NegotiableQuoteUidOperationSuccess attributes

The NegotiableQuoteUidOperationSuccess object contains details about a successful operation on a negotiable quote. It implements the NegotiableQuoteUidNonFatalResultInterface, which defines the following field

NegotiableQuote attributes

The NegotiableQuote object contains details of a negotiable quote, including its status, contents, and history.

NegotiableQuoteComment attributes

The NegotiableQuoteComment object contains details about a single comment made by the seller or the buyer.

NegotiableQuoteCustomLogChange attributes

The NegotiableQuoteCustomLogChange object contains changes to a negotiable quote that were made by a third-party extension.

NegotiableQuoteHistoryChanges attributes

The NegotiableQuoteHistoryChanges object contains details about a single change in the history of a negotiable quote.

NegotiableQuoteHistoryCommentChange attributes

The NegotiableQuoteHistoryCommentChange object contains a plain-text comment.

NegotiableQuoteHistoryEntry attributes

The NegotiableQuoteHistoryEntry object contains details about a change to a negotiable quote, including all previous changes made at that point.

NegotiableQuoteHistoryExpirationChange attributes

The NegotiableQuoteHistoryExpirationChange object lists the current expiration date of the negotiable quote, and the previous expiration date, if applicable.

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.

NegotiableQuoteHistoryStatusChange attributes

The NegotiableQuoteHistoryStatusChange object returns the status changes during the quote’s life cycle.

NegotiableQuoteHistoryStatusesChange attributes

The NegotiableQuoteHistoryStatusesChange object contains an array of all previous modifications to the negotiable quote.

NegotiableQuoteHistoryTotalChange attributes

The NegotiableQuoteHistoryTotalChange object contains the new total price of a negotiable quote after some change has been applied.

NegotiableQuoteUser attributes

The NegotiableQuoteUser contains the first and last name of a buyer or seller.