B2B for Adobe Commerce only. Learn more.

setNegotiableQuoteBillingAddress mutation

The setNegotiableQuoteBillingAddress mutation assigns the billing address for the specified negotiable quote. You can assign an address from the company user’s address book, or define a new one. The negotiable quote must be in the UPDATED state to successfully set the billing address.

To return a list of valid billing addresses, construct a company query that includes the user input attribute.

This query requires a valid customer authentication token.

Syntax

1
2
3
4
5
{
    setNegotiableQuoteBillingAddress(
        input: SetNegotiableQuoteBillingAddressInput!
    ): SetNegotiableQuoteBillingAddressOutput
}

Example usage

The following example adds a new billing address to a negotiable quote.

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
mutation {
  setNegotiableQuoteBillingAddress(input: {
    quote_uid: "prFSdZyHOpMXeiJ32XlBzd8e1Mte9loS",
    billing_address: {
      address: {
        company: "TestCo"
        firstname: "Taina"
        lastname: "Garofalo"
        street: "100 Big Oak Tree Dr"
        city: "San Francisco"
        postcode: "9999"
        region: "CA"
        region_id: 12
        country_code: "US"
        telephone: "555 999-9999"
      }
    }
  }) {
    quote {
      billing_address {
        company
        firstname
        lastname
        street
        city
        region {
          label
          code
        }
        country {
          label
          code
        }
      }
    }
  }
}

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
{
  "data": {
    "setNegotiableQuoteBillingAddress": {
      "quote": {
        "billing_address": {
          "company": "TestCo",
          "firstname": "Taina",
          "lastname": "Garofalo",
          "street": [
            "100 Big Oak Tree Dr"
          ],
          "city": "San Francisco",
          "region": {
            "label": "California",
            "code": "CA"
          },
          "country": {
            "label": "US",
            "code": "US"
          }
        }
      }
    }
  }
}

Input attributes

The SetNegotiableQuoteBillingAddressInput input object specifies the company user’s cart ID and the billing address.

SetNegotiableQuoteBillingAddressInput attributes

The SetNegotiableQuoteBillingAddressInput object contains the following attributes.

Attribute Data Type Description
billing_address NegotiableQuoteBillingAddressInput! The billing address to be added
quote_uid ID! The unique ID of a NegotiableQuote object

NegotiableQuoteBillingAddressInput attributes

Attribute Data Type Description
address NegotiableQuoteAddressInput Defines a billing address
customer_address_uid ID The unique ID of a CustomerAddress object
same_as_shipping Boolean Indicates whether to set the billing address to be the same as the existing shipping address on the negotiable quote
use_for_shipping Boolean Indicates whether to set the shipping address to be the same as this billing address

NegotiableQuoteAddressInput

The NegotiableQuoteAddressInput object contains the following attributes.

Attribute Data Type Description
city String! The city specified for the billing or shipping address
company String The company name
country_code String! The country code and label for the billing or shipping address
firstname String! The first name of the company user
lastname String! The last name of the company user
postcode String The ZIP or postal code of the billing or shipping address
region String A string that defines the state or province of the billing or shipping address
region_id Int An integer that defines the state or province of the billing or shipping address
save_in_address_book Boolean Determines whether to save the address in the customer’s address book. The default value is true
street [String!]! An array containing the street for the billing or shipping address
telephone String The telephone number for the billing or shipping address

Output attributes

The SetNegotiableQuoteBillingAddressOutput output object contains the following attribute.

Attribute Data Type Description
quote NegotiableQuote The negotiable quote after setting the billing address

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