B2B for Adobe Commerce only.
Learn more.
negotiableQuote query
The negotiableQuote query retrieves details about the specified negotiable quote. Use the negotiableQuotes query to return a list of valid uid values.
This query requires a valid customer authentication token.
Syntax
1
negotiableQuote (uid ID!): NegotiableQuote
Example usage
The following example returns information about the negotiable quote with the UID of kw6mLEvl6vjjPNsjtJqwpamv5o0iT1bc. The buyer and seller agreed to a five percent discount on the order.
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
60
61
62
63
64
65
66
67
query{
negotiableQuote(uid: "kw6mLEvl6vjjPNsjtJqwpamv5o0iT1bc"){
uid
status
total_quantity
email
items {
product {
name
sku
uid
price_range {
maximum_price {
regular_price {
value
}
}
}
}
quantity
}
comments {
uid
created_at
author {
firstname
lastname
}
text
}
history {
uid
created_at
author {
firstname
lastname
}
change_type
changes {
comment_added {
comment
}
statuses {
changes {
new_status
old_status
}
}
expiration {
new_expiration
old_expiration
}
}
total {
new_price {
value
}
old_price {
value
}
}
}
}
uid
updated_at
}
}
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
{
"data": {
"negotiableQuote": {
"uid": "kw6mLEvl6vjjPNsjtJqwpamv5o0iT1bc",
"status": "ORDERED",
"total_quantity": 3,
"email": "tgarofalo@example.com",
"items": [
{
"product": {
"name": "Dual Handle Cardio Ball",
"sku": "24-UG07",
"price_range": {
"maximum_price": {
"regular_price": {
"value": 12
}
}
}
},
"quantity": 1
},
{
"product": {
"name": "Sprite Yoga Companion Kit",
"sku": "24-WG080",
"price_range": {
"maximum_price": {
"regular_price": {
"value": 77
}
}
}
},
"quantity": 1
},
{
"product": {
"name": "Zing Jump Rope",
"sku": "24-UG04",
"price_range": {
"maximum_price": {
"regular_price": {
"value": 12
}
}
}
},
"quantity": 1
}
],
"comments": [
{
"uid": "MQ==",
"created_at": "2021-04-20 19:57:49",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"text": "Requesting a 10% discount for being a repeat customer."
},
{
"uid": "Mg==",
"created_at": "2021-04-21 16:06:51",
"author": {
"firstname": "John Paul",
"lastname": "Pope"
},
"text": "Hello Taina! Thanks for registering with Luma as a partner company.\r\n\r\nUnfortunately, we cannot grant your request, because the 10% discount is reserved for our frequent customers, and this is your first order. We can offer a 5% discount on this order."
},
{
"uid": "Mw==",
"created_at": "2021-04-21 16:12:48",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"text": "I understand. I'll accept your offer."
},
{
"uid": "NA==",
"created_at": "2021-04-21 17:03:36",
"author": {
"firstname": "John Paul",
"lastname": "Pope"
},
"text": "Great! You should see a 5% discount in your cart. Shipping fees and taxes might apply."
},
{
"uid": "NQ==",
"created_at": "2021-04-21 17:54:34",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"text": "Adding a shipping address"
}
],
"history": [
{
"uid": "MQ==",
"created_at": "2021-04-20 19:57:49",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"change_type": "CREATED",
"changes": {
"comment_added": {
"comment": "Requesting a 10% discount for being a repeat customer."
},
"statuses": {
"changes": [
{
"new_status": "SUBMITTED",
"old_status": null
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "Mg==",
"created_at": "2021-04-21 15:55:09",
"author": {
"firstname": "admin",
"lastname": "admin"
},
"change_type": "UPDATED",
"changes": {
"comment_added": null,
"statuses": {
"changes": [
{
"new_status": "PENDING",
"old_status": "SUBMITTED"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "Mw==",
"created_at": "2021-04-21 16:06:51",
"author": {
"firstname": "admin",
"lastname": "admin"
},
"change_type": "UPDATED",
"changes": {
"comment_added": {
"comment": "Hello Taina! Thanks for registering with Luma as a partner company.\r\n\r\nUnfortunately, we cannot grant your request, because the 10% discount is reserved for our frequent customers, and this is your first order. We can offer a 5% discount on this order."
},
"statuses": {
"changes": [
{
"new_status": "UPDATED",
"old_status": "PENDING"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "NA==",
"created_at": "2021-04-21 16:12:48",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"change_type": "UPDATED",
"changes": {
"comment_added": {
"comment": "I understand. I'll accept your offer."
},
"statuses": {
"changes": [
{
"new_status": "SUBMITTED",
"old_status": "UPDATED"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "NQ==",
"created_at": "2021-04-21 17:02:18",
"author": {
"firstname": "admin",
"lastname": "admin"
},
"change_type": "UPDATED",
"changes": {
"comment_added": null,
"statuses": {
"changes": [
{
"new_status": "PENDING",
"old_status": "SUBMITTED"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "Ng==",
"created_at": "2021-04-21 17:03:36",
"author": {
"firstname": "admin",
"lastname": "admin"
},
"change_type": "UPDATED",
"changes": {
"comment_added": {
"comment": "Great! You should see a 5% discount in your cart. Shipping fees and taxes might apply."
},
"statuses": {
"changes": [
{
"new_status": "UPDATED",
"old_status": "PENDING"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": {
"value": 95.95
},
"old_price": {
"value": 101
}
}
}
},
{
"uid": "Nw==",
"created_at": "2021-04-21 17:54:08",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"change_type": "UPDATED",
"changes": {
"comment_added": null,
"statuses": {
"changes": [
{
"new_status": "OPEN",
"old_status": "UPDATED"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "OA==",
"created_at": "2021-04-21 17:54:34",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"change_type": "UPDATED",
"changes": {
"comment_added": {
"comment": "Adding a shipping address"
},
"statuses": {
"changes": [
{
"new_status": "SUBMITTED",
"old_status": "OPEN"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "OQ==",
"created_at": "2021-04-21 18:23:56",
"author": {
"firstname": "admin",
"lastname": "admin"
},
"change_type": "UPDATED",
"changes": {
"comment_added": null,
"statuses": {
"changes": [
{
"new_status": "PENDING",
"old_status": "SUBMITTED"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "MTA=",
"created_at": "2021-04-21 18:24:46",
"author": {
"firstname": "admin",
"lastname": "admin"
},
"change_type": "UPDATED",
"changes": {
"comment_added": null,
"statuses": {
"changes": [
{
"new_status": "UPDATED",
"old_status": "PENDING"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
},
{
"uid": "MTE=",
"created_at": "2021-04-21 18:29:29",
"author": {
"firstname": "Taina",
"lastname": "Garofalo"
},
"change_type": "UPDATED",
"changes": {
"comment_added": null,
"statuses": {
"changes": [
{
"new_status": "OPEN",
"old_status": "UPDATED"
},
{
"new_status": "ORDERED",
"old_status": "OPEN"
}
]
},
"expiration": {
"new_expiration": "Never",
"old_expiration": null
},
"total": {
"new_price": null,
"old_price": null
}
}
}
],
"updated_at": "2021-04-21 18:29:28"
}
}
}
Input attributes
The negotiableQuote query requires a valid negotiable quote ID.
| Attribute | Data Type | Description |
|---|---|---|
uid |
ID! | The unique ID assigned to the negotiable quote |
Output 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 |