requestNegotiableQuote mutation

The requestNegotiableQuote mutation initiates a negotiable quote on behalf of a company user. The company user must add all products to the cart before requesting a negotiable quote. Once the request is submitted, company users cannot add new products to the quote.

If the request is successful, Magento assigns the cart ID to the negotiable quote. Therefore, the same cart ID is used throughout the lifecycle of the negotiable quote. Magento generates a new cart ID if the company user starts a new order while a negotiable quote is in process. The cart ID must be active. You cannot create a negotiable quote if the quote is cancelled or converted to an order.

If the request is successful, the negotiable quote has the SUBMITTED status.

If the negotiable quote requires a shipping address (for negotiation or tax calculations), you can use the setNegotiableQuoteShippingAddresses mutation to add the address to the standard quote during the negotiable quote process.

This mutation requires a valid customer authentication token.

Syntax

1
2
3
requestNegotiableQuote(
    input: RequestNegotiableQuoteInput!
): RequestNegotiableQuoteOutput

Example usage

The following example requests a negotiable quote. The cart contains three items.

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
mutation {
  requestNegotiableQuote (
    input: {
      cart_id: "kw6mLEvl6vjjPNsjtJqwpamv5o0iT1bc"
      quote_name: "Discount request"
      comment: {
        comment: "Requesting a 10% discount for being a repeat customer."}
    }
  ){
    quote {
      uid
      created_at
      status
      buyer {
        firstname
        lastname
      }
      comments {
        uid
        created_at
        author {
          firstname
          lastname
        }
        creator_type
        text
      }
      items {
        product {
          uid
          sku
          name
          price_range {
            maximum_price {
              regular_price {
                value
              }
            }
          }
        }
        quantity
      }
      prices {
        subtotal_excluding_tax {
          value
        }
        subtotal_including_tax {
          value
        }
        subtotal_with_discount_excluding_tax {
          value
        }
        grand_total {
          value
        }
      }
    }
  }
}

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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
{
  "data": {
    "requestNegotiableQuote": {
      "quote": {
        "uid": "kw6mLEvl6vjjPNsjtJqwpamv5o0iT1bc",
        "created_at": "2021-04-20 19:01:38",
        "status": "SUBMITTED",
        "buyer": {
          "firstname": "Taina",
          "lastname": "Garofalo"
        },
        "comments": [
          {
            "uid": "MQ==",
            "created_at": "2021-04-20 19:57:49",
            "author": {
              "firstname": "Taina",
              "lastname": "Garofalo"
            },
            "creator_type": "BUYER",
            "text": "Requesting a 10% discount for being a repeat customer."
          }
        ],
        "items": [
          {
            "product": {
              "uid": "MTY=",
              "sku": "24-UG07",
              "name": "Dual Handle Cardio Ball",
              "price_range": {
                "maximum_price": {
                  "regular_price": {
                    "value": 12
                  }
                }
              }
            },
            "quantity": 1
          },
          {
            "product": {
              "uid": "NTI=",
              "sku": "24-WG080",
              "name": "Sprite Yoga Companion Kit",
              "price_range": {
                "maximum_price": {
                  "regular_price": {
                    "value": 77
                  }
                }
              }
            },
            "quantity": 1
          },
          {
            "product": {
              "uid": "MTc=",
              "sku": "24-UG04",
              "name": "Zing Jump Rope",
              "price_range": {
                "maximum_price": {
                  "regular_price": {
                    "value": 12
                  }
                }
              }
            },
            "quantity": 1
          }
        ],
        "prices": {
          "subtotal_excluding_tax": {
            "value": 101
          },
          "subtotal_including_tax": {
            "value": 101
          },
          "subtotal_with_discount_excluding_tax": {
            "value": 101
          },
          "grand_total": {
            "value": 101
          }
        }
      }
    }
  }
}

Input attributes

The RequestNegotiableQuoteInput input object specifies the company user’s cart ID and other information to identify a new negotiable quote.

RequestNegotiableQuoteInput attributes

The RequestNegotiableQuoteInput object contains the following attributes.

NegotiableQuoteCommentInput

The NegotiableQuoteCommentInput object contains the following attribute.

Output attributes

The RequestNegotiableQuoteOutput output object contains the following attribute.

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.