Customer

Defines the customer name, addresses, and other details.

Fields

Example

{
  "addresses": [CustomerAddress],
  "addressesV2": CustomerAddresses,
  "admin_assistance_actions": AdminAssistanceActions,
  "allow_remote_shopping_assistance": true,
  "companies": UserCompaniesOutput,
  "company_hierarchy": [CompanyHierarchy],
  "compare_list": CompareList,
  "confirmation_status": "ACCOUNT_CONFIRMED",
  "created_at": "abc123",
  "custom_attributes": [AttributeValueInterface],
  "date_of_birth": "xyz789",
  "default_billing": "abc123",
  "default_shipping": "abc123",
  "email": "xyz789",
  "firstname": "xyz789",
  "gender": 987,
  "gift_registries": [GiftRegistry],
  "gift_registry": GiftRegistry,
  "group": CustomerGroupStorefront,
  "id": 4,
  "is_subscribed": false,
  "job_title": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "orders": CustomerOrders,
  "prefix": "xyz789",
  "purchase_order": PurchaseOrder,
  "purchase_order_approval_rule": PurchaseOrderApprovalRule,
  "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
  "purchase_order_approval_rules": PurchaseOrderApprovalRules,
  "purchase_orders": PurchaseOrders,
  "purchase_orders_enabled": false,
  "quote_enabled": false,
  "requisition_lists": RequisitionLists,
  "return": Return,
  "returns": Returns,
  "reward_points": RewardPoints,
  "role": CompanyRole,
  "segments": [CustomerSegmentStorefront],
  "status": "ACTIVE",
  "store_credit": CustomerStoreCredit,
  "structure_id": 4,
  "suffix": "abc123",
  "taxvat": "abc123",
  "team": CompanyTeam,
  "telephone": "abc123",
  "wishlist_v2": Wishlist,
  "wishlists": [Wishlist]
}

CustomerAddress

Contains detailed information about a customer's billing or shipping address.

Fields

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "AF",
  "custom_attributesV2": [AttributeValueInterface],
  "default_billing": true,
  "default_shipping": true,
  "extension_attributes": [CustomerAddressAttribute],
  "fax": "abc123",
  "firstname": "xyz789",
  "id": 987,
  "lastname": "abc123",
  "middlename": "abc123",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": CustomerAddressRegion,
  "region_id": 987,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "abc123",
  "uid": 4,
  "vat_id": "abc123"
}

CustomerAddressAttribute

Specifies the attribute code and value of a customer address attribute.

Fields

Example

{
  "attribute_code": "xyz789",
  "value": "xyz789"
}

CustomerAddressInput

Contains details about a billing or shipping address.

Input Fields

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "AF",
  "custom_attributesV2": [AttributeValueInput],
  "default_billing": false,
  "default_shipping": false,
  "fax": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "abc123",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CustomerAddressRegionInput,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "vat_id": "abc123"
}

CustomerAddressRegion

Defines the customer's state or province.

Fields

Example

{
  "region": "xyz789",
  "region_code": "abc123",
  "region_id": 987
}

CustomerAddressRegionInput

Defines the customer's state or province.

Input Fields

Example

{
  "region": "xyz789",
  "region_code": "xyz789",
  "region_id": 987
}

CustomerAddresses

Fields

Example

{
  "items": [CustomerAddress],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CustomerAttributeMetadata

Customer attribute metadata.

Fields

Example

{
  "code": "4",
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "input_filter": "NONE",
  "is_required": true,
  "is_unique": false,
  "label": "abc123",
  "multiline_count": 987,
  "options": [CustomAttributeOptionInterface],
  "sort_order": 987,
  "validate_rules": [ValidationRule]
}

CustomerCreateInput

An input object for creating a customer.

Input Fields

Example

{
  "allow_remote_shopping_assistance": false,
  "custom_attributes": [AttributeValueInput],
  "date_of_birth": "abc123",
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "is_subscribed": false,
  "lastname": "xyz789",
  "middlename": "xyz789",
  "password": "abc123",
  "prefix": "xyz789",
  "suffix": "abc123",
  "taxvat": "abc123"
}

CustomerDownloadableProduct

Contains details about a single downloadable product.

Fields

Example

{
  "date": "abc123",
  "download_url": "abc123",
  "order_increment_id": "abc123",
  "remaining_downloads": "xyz789",
  "status": "xyz789"
}

CustomerDownloadableProducts

Contains a list of downloadable products.

Fields

Example

{"items": [CustomerDownloadableProduct]}

CustomerGroupStorefront

Data of customer group.

Fields

Example

{"uid": 4}

CustomerOrder

Contains details about each of the customer's orders.

Fields

Example

{
  "admin_assisted_order": 987,
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [ApplyGiftCardToOrder],
  "available_actions": ["REORDER"],
  "billing_address": OrderAddress,
  "carrier": "abc123",
  "comments": [SalesCommentItem],
  "credit_memos": [CreditMemo],
  "custom_attributes": [CustomAttribute],
  "customer_info": OrderCustomerInfo,
  "email": "abc123",
  "gift_message": GiftMessage,
  "gift_receipt_included": false,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "invoices": [Invoice],
  "is_virtual": true,
  "items": [OrderItemInterface],
  "items_eligible_for_return": [OrderItemInterface],
  "negotiable_quote": NegotiableQuote,
  "number": "abc123",
  "order_date": "xyz789",
  "order_status_change_date": "xyz789",
  "payment_methods": [OrderPaymentMethod],
  "printed_card_included": true,
  "returns": Returns,
  "shipments": [OrderShipment],
  "shipping_address": OrderAddress,
  "shipping_method": "abc123",
  "status": "xyz789",
  "token": "xyz789",
  "total": OrderTotal
}

CustomerOrderSortInput

CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Input Fields

Example

{"sort_direction": "ASC", "sort_field": "NUMBER"}

CustomerOrderSortableField

Specifies the field to use for sorting

Values

Example

""NUMBER""

CustomerOrders

The collection of orders that match the conditions defined in the filter.

Fields

Example

{
  "date_of_first_order": "abc123",
  "items": [CustomerOrder],
  "page_info": SearchResultPageInfo,
  "total_count": 123
}

CustomerOrdersFilterInput

Identifies the filter to use for filtering orders.

Input Fields

Example

{
  "grand_total": FilterRangeTypeInput,
  "number": FilterStringTypeInput,
  "order_date": FilterRangeTypeInput,
  "status": FilterEqualTypeInput
}

CustomerOutput

Contains details about a newly-created or updated customer.

Fields

Example

{"customer": Customer}

CustomerPaymentTokens

Contains payment tokens stored in the customer's vault.

Fields

Example

{"items": [PaymentToken]}

CustomerSegmentStorefront

Customer segment details

Fields

Example

{"uid": 4}

CustomerStoreCredit

Contains store credit information with balance and history.

Fields

Example

{
  "balance_history": CustomerStoreCreditHistory,
  "current_balance": Money,
  "enabled": true
}

CustomerStoreCreditHistory

Lists changes to the amount of store credit available to the customer.

Fields

Example

{
  "items": [CustomerStoreCreditHistoryItem],
  "page_info": SearchResultPageInfo,
  "total_count": 987
}

CustomerStoreCreditHistoryItem

Contains store credit history information.

Fields

Example

{
  "action": "abc123",
  "actual_balance": Money,
  "balance_change": Money,
  "date_time_changed": "xyz789"
}

CustomerToken

Contains a customer authorization token.

Fields

Example

{"token": "xyz789"}

CustomerUpdateInput

An input object for updating a customer.

Input Fields

Example

{
  "allow_remote_shopping_assistance": false,
  "custom_attributes": [AttributeValueInput],
  "date_of_birth": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "xyz789",
  "prefix": "xyz789",
  "suffix": "xyz789",
  "taxvat": "abc123"
}

CustomizableAreaOption

Contains information about a text area that is defined as part of a customizable option.

Fields

Example

{
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableAreaValue
}

CustomizableAreaValue

Defines the price and sku of a product whose page contains a customized text area.

Fields

Example

{
  "max_characters": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": "4"
}

CustomizableCheckboxOption

Contains information about a set of checkbox values that are defined as part of a customizable option.

Fields

Example

{
  "required": false,
  "sort_order": 123,
  "title": "xyz789",
  "uid": "4",
  "value": [CustomizableCheckboxValue]
}

CustomizableCheckboxValue

Defines the price and sku of a product whose page contains a customized set of checkbox values.

Fields

Example

{
  "option_type_id": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "abc123",
  "uid": 4
}

CustomizableDateOption

Contains information about a date picker that is defined as part of a customizable option.

Fields

Example

{
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 123,
  "title": "xyz789",
  "uid": "4",
  "value": CustomizableDateValue
}

CustomizableDateTypeEnum

Defines the customizable date type.

Values

Example

""DATE""

CustomizableDateValue

Defines the price and sku of a product whose page contains a customized date picker.

Fields

Example

{
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "type": "DATE",
  "uid": "4"
}

CustomizableDropDownOption

Contains information about a drop down menu that is defined as part of a customizable option.

Fields

Example

{
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableDropDownValue]
}

CustomizableDropDownValue

Defines the price and sku of a product whose page contains a customized drop down menu.

Fields

Example

{
  "option_type_id": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 123,
  "title": "abc123",
  "uid": 4
}

CustomizableFieldOption

Contains information about a text field that is defined as part of a customizable option.

Fields

Example

{
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableFieldValue
}

CustomizableFieldValue

Defines the price and sku of a product whose page contains a customized text field.

Fields

Example

{
  "max_characters": 123,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": "4"
}

CustomizableFileOption

Contains information about a file picker that is defined as part of a customizable option.

Fields

Example

{
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 987,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableFileValue
}

CustomizableFileValue

Defines the price and sku of a product whose page contains a customized file picker.

Fields

Example

{
  "file_extension": "abc123",
  "image_size_x": 987,
  "image_size_y": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": 4
}

CustomizableMultipleOption

Contains information about a multiselect that is defined as part of a customizable option.

Fields

Example

{
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableMultipleValue]
}

CustomizableMultipleValue

Defines the price and sku of a product whose page contains a customized multiselect.

Fields

Example

{
  "option_type_id": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 987,
  "title": "abc123",
  "uid": 4
}

CustomizableOptionInput

Defines a customizable option.

Input Fields

Example

{
  "uid": "4",
  "value_string": "abc123"
}

CustomizableOptionInterface

Contains basic information about a customizable option. It can be implemented by several types of configurable options.

Fields

Possible Types

Example

{
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": "4"
}

CustomizableProductInterface

Contains information about customizable product options.

Fields

Possible Types

Example

{"options": [CustomizableOptionInterface]}

CustomizableRadioOption

Contains information about a set of radio buttons that are defined as part of a customizable option.

Fields

Example

{
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "uid": "4",
  "value": [CustomizableRadioValue]
}

CustomizableRadioValue

Defines the price and sku of a product whose page contains a customized set of radio buttons.

Fields

Example

{
  "option_type_id": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "abc123",
  "uid": 4
}

DateTime

A slightly refined version of RFC-3339 compliant DateTime Scalar

Example

"2007-12-03T10:15:30Z"

DeleteCompanyRoleOutput

Contains the response to the request to delete the company role.

Fields

Example

{"success": false}

DeleteCompanyTeamOutput

Contains the status of the request to delete a company team.

Fields

Example

{"success": true}

DeleteCompanyUserOutput

Contains the response to the request to delete the company user.

Fields

Example

{"success": false}

DeleteCompareListOutput

Contains the results of the request to delete a compare list.

Fields

Example

{"result": true}

DeleteNegotiableQuoteError

Types

Example

NegotiableQuoteInvalidStateError

DeleteNegotiableQuoteOperationFailure

Contains details about a failed delete operation on a negotiable quote.

Fields

Example

{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": 4
}

DeleteNegotiableQuoteOperationResult

Types

Example

NegotiableQuoteUidOperationSuccess

DeleteNegotiableQuoteTemplateInput

Specifies the quote template id of the quote template to delete

Input Fields

Example

{"template_id": 4}

DeleteNegotiableQuotesInput

Input Fields

Example

{"quote_uids": [4]}

DeleteNegotiableQuotesOutput

Contains a list of undeleted negotiable quotes the company user can view.

Fields

Example

{
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

DeletePaymentTokenOutput

Indicates whether the request succeeded and returns the remaining customer payment tokens.

Fields

Example

{
  "customerPaymentTokens": CustomerPaymentTokens,
  "result": false
}

DeletePurchaseOrderApprovalRuleError

Contains details about an error that occurred when deleting an approval rule .

Fields

Example

{"message": "abc123", "type": "UNDEFINED"}

DeletePurchaseOrderApprovalRuleErrorType

Values

Example

""UNDEFINED""

DeletePurchaseOrderApprovalRuleInput

Specifies the IDs of the approval rules to delete.

Input Fields

Example

{"approval_rule_uids": [4]}

DeletePurchaseOrderApprovalRuleOutput

Contains any errors encountered while attempting to delete approval rules.

Fields

Example

{"errors": [DeletePurchaseOrderApprovalRuleError]}

DeleteRequisitionListItemsOutput

Output of the request to remove items from the requisition list.

Fields

Example

{"requisition_list": RequisitionList}

DeleteRequisitionListOutput

Indicates whether the request to delete the requisition list was successful.

Fields

Example

{"requisition_lists": RequisitionLists, "status": false}

DeleteWishlistOutput

Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists.

Fields

Example

{"status": true, "wishlists": [Wishlist]}

Discount

Specifies the discount type and value for quote line item.

Fields

Example

{
  "amount": Money,
  "applied_to": "ITEM",
  "coupon": AppliedCoupon,
  "is_discounting_locked": true,
  "label": "xyz789",
  "type": "abc123",
  "value": 123.45
}

DownloadableCartItem

An implementation for downloadable product cart items.

Fields

Example

{
  "backorder_message": "xyz789",
  "custom_attributes": [CustomAttribute],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "is_available": true,
  "is_salable": false,
  "links": [DownloadableProductLinks],
  "max_qty": 987.65,
  "min_qty": 123.45,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "samples": [DownloadableProductSamples],
  "uid": 4
}

DownloadableCreditMemoItem

Defines downloadable product options for CreditMemoItemInterface.

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 987.65
}

DownloadableInvoiceItem

Defines downloadable product options for InvoiceItemInterface.

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_invoiced": 123.45
}

DownloadableItemsLinks

Defines characteristics of the links for downloadable product.

Fields

Example

{
  "sort_order": 987,
  "title": "abc123",
  "uid": "4"
}

DownloadableOrderItem

Defines downloadable product options for OrderItemInterface.

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "downloadable_links": [DownloadableItemsLinks],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "abc123",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_return_requested": 987.65,
  "quantity_returned": 123.45,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

DownloadableProduct

Defines a product that the shopper downloads.

Fields

Example

{
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "country_of_manufacture": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "downloadable_product_links": [
    DownloadableProductLinks
  ],
  "downloadable_product_samples": [
    DownloadableProductSamples
  ],
  "gift_message_available": false,
  "gift_wrapping_available": false,
  "gift_wrapping_price": Money,
  "image": ProductImage,
  "is_returnable": "abc123",
  "links_purchased_separately": 123,
  "links_title": "xyz789",
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "abc123",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 987.65,
  "related_products": [ProductInterface],
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_price": 987.65,
  "special_to_date": "abc123",
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "uid": 4,
  "upsell_products": [ProductInterface],
  "url_key": "xyz789"
}

DownloadableProductCartItemInput

Defines a single downloadable product.

Input Fields

Example

{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "downloadable_product_links": [
    DownloadableProductLinksInput
  ]
}

DownloadableProductLinks

Defines characteristics of a downloadable product.

Fields

Example

{
  "price": 987.65,
  "sample_url": "xyz789",
  "sort_order": 123,
  "title": "xyz789",
  "uid": "4"
}

DownloadableProductLinksInput

Contains the link ID for the downloadable product.

Input Fields

Example

{"link_id": 987}

DownloadableProductSamples

Defines characteristics of a downloadable product.

Fields

Example

{
  "sample_url": "abc123",
  "sort_order": 123,
  "title": "abc123"
}

DownloadableRequisitionListItem

Contains details about downloadable products added to a requisition list.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "links": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 987.65,
  "samples": [DownloadableProductSamples],
  "sku": "abc123",
  "uid": 4
}

DownloadableWishlistItem

A downloadable product wish list item.

Fields

Example

{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "links_v2": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 987.65,
  "samples": [DownloadableProductSamples]
}

DuplicateNegotiableQuoteInput

Identifies a quote to be duplicated

Input Fields

Example

{"duplicated_quote_uid": 4, "quote_uid": 4}

DuplicateNegotiableQuoteOutput

Contains the newly created negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

EnteredCustomAttributeInput

Contains details about a custom text attribute that the buyer entered.

Input Fields

Example

{
  "attribute_code": "xyz789",
  "value": "abc123"
}

EnteredOptionInput

Defines a customer-entered option.

Input Fields

Example

{"uid": 4, "value": "xyz789"}

Error

An error encountered while adding an item to the the cart.

Fields

Possible Types

Example

{
  "code": "PRODUCT_NOT_FOUND",
  "message": "abc123"
}

ErrorInterface

Fields

Possible Types

Example

{"message": "abc123"}

EstimateAddressInput

Contains details about an address.

Input Fields

Example

{
  "country_code": "AF",
  "postcode": "xyz789",
  "region": CustomerAddressRegionInput
}

EstimateTotalsInput

Input Fields

Example

{
  "address": EstimateAddressInput,
  "cart_id": "xyz789",
  "shipping_method": ShippingMethodInput
}

EstimateTotalsOutput

Estimate totals output.

Fields

Example

{"cart": Cart}

ExchangeExternalCustomerTokenInput

Contains details about external customer.

Input Fields

Example

{"customer": CustomerCreateInput}

ExchangeExternalCustomerTokenOutput

Contains customer token for external customer.

Fields

Example

{
  "customer": Customer,
  "token": "abc123"
}

ExchangeRate

Lists the exchange rate.

Fields

Example

{"currency_to": "abc123", "rate": 987.65}

FastlaneConfig

Fields

Example

{
  "code": "abc123",
  "is_visible": true,
  "payment_intent": "xyz789",
  "payment_source": "xyz789",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "three_ds_mode": "OFF",
  "title": "xyz789"
}

FastlaneMethodInput

Fastlane Payment inputs

Input Fields

Example

{
  "payment_source": "xyz789",
  "paypal_fastlane_token": "xyz789"
}

Field

Values

Example

""UNKNOWN_FIELD""

FilterEqualTypeInput

Defines a filter that matches the input exactly.

Input Fields

Example

{
  "eq": "abc123",
  "in": ["abc123"]
}

FilterMatchTypeEnum

Values

Example

""FULL""

FilterMatchTypeInput

Defines a filter that performs a fuzzy search.

Input Fields

Example

{"match": "abc123", "match_type": "FULL"}

FilterRangeTypeInput

Defines a filter that matches a range of values, such as prices or dates.

Input Fields

Example

{
  "from": "xyz789",
  "to": "abc123"
}

FilterRuleInput

Input Fields

Example

{
  "name": "xyz789",
  "type": "UNKNOWN_FILTER_RULE_TYPE",
  "conditions": [ConditionInput]
}

FilterRuleType

Values

Example

""UNKNOWN_FILTER_RULE_TYPE""

FilterStringTypeInput

Defines a filter for an input string.

Input Fields

Example

{
  "eq": "xyz789",
  "in": ["xyz789"],
  "match": "xyz789"
}

FilterTypeInput

Defines the comparison operators that can be used in a filter.

Input Fields

Example

{
  "eq": "xyz789",
  "from": "xyz789",
  "gt": "abc123",
  "gteq": "abc123",
  "in": ["xyz789"],
  "like": "xyz789",
  "lt": "xyz789",
  "lteq": "abc123",
  "moreq": "xyz789",
  "neq": "abc123",
  "nin": ["abc123"],
  "notnull": "xyz789",
  "null": "abc123",
  "to": "abc123"
}

FilterableInSearchAttribute

Contains product attributes that can be used for filtering in a productSearch query

Fields

Example

{
  "attribute": "abc123",
  "frontendInput": "xyz789",
  "label": "abc123",
  "numeric": false
}

FixedProductTax

A single FPT that can be applied to a product price.

Fields

Example

{
  "amount": Money,
  "label": "abc123"
}

FixedProductTaxDisplaySettings

Lists display settings for the Fixed Product Tax.

Values

Example

""INCLUDE_FPT_WITHOUT_DETAILS""

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

GenerateCustomerTokenAsAdminInput

Identifies which customer requires remote shopping assistance.

Input Fields

Example

{"customer_email": "abc123"}

GenerateCustomerTokenAsAdminOutput

Contains the generated customer token.

Fields

Example

{"customer_token": "abc123"}

GenerateNegotiableQuoteFromTemplateInput

Specifies the template id, from which to generate quote from.

Input Fields

Example

{"template_id": "4"}

GenerateNegotiableQuoteFromTemplateOutput

Contains the generated negotiable quote id.

Fields

Example

{"negotiable_quote_uid": 4}

GetPaymentSDKOutput

Gets the payment SDK URLs and values

Fields

Example

{"sdkParams": [PaymentSDKParamsItem]}

GiftCardAccount

Contains details about the gift card account.

Fields

Example

{
  "balance": Money,
  "code": "abc123",
  "expiration_date": "abc123"
}

GiftCardAccountInput

Contains the gift card code.

Input Fields

Example

{"gift_card_code": "xyz789"}

GiftCardAmounts

Contains the value of a gift card, the website that generated the card, and related information.

Fields

Example

{
  "attribute_id": 987,
  "uid": "4",
  "value": 987.65,
  "website_id": 123,
  "website_value": 123.45
}

GiftCardCartItem

Contains details about a gift card that has been added to a cart.

Fields

Example

{
  "amount": Money,
  "available_gift_wrapping": [GiftWrapping],
  "backorder_message": "xyz789",
  "custom_attributes": [CustomAttribute],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "is_available": false,
  "is_salable": false,
  "max_qty": 987.65,
  "message": "abc123",
  "min_qty": 987.65,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "recipient_email": "xyz789",
  "recipient_name": "xyz789",
  "sender_email": "xyz789",
  "sender_name": "abc123",
  "uid": "4"
}

GiftCardCreditMemoItem

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_refunded": 123.45
}

GiftCardInvoiceItem

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "gift_card": GiftCardItem,
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

GiftCardItem

Contains details about a gift card.

Fields

Example

{
  "message": "xyz789",
  "recipient_email": "xyz789",
  "recipient_name": "xyz789",
  "sender_email": "abc123",
  "sender_name": "xyz789"
}

GiftCardOptions

Contains details about the sender, recipient, and amount of a gift card.

Fields

Example

{
  "amount": Money,
  "custom_giftcard_amount": Money,
  "message": "xyz789",
  "recipient_email": "xyz789",
  "recipient_name": "xyz789",
  "sender_email": "xyz789",
  "sender_name": "abc123"
}

GiftCardOrderItem

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "eligible_for_return": false,
  "entered_options": [OrderItemOption],
  "gift_card": GiftCardItem,
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "product_type": "abc123",
  "product_url_key": "xyz789",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 123.45,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 987.65,
  "quantity_returned": 987.65,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

GiftCardProduct

Defines properties of a gift card.

Fields

Example

{
  "allow_message": true,
  "allow_open_amount": false,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "country_of_manufacture": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_card_options": [CustomizableOptionInterface],
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "giftcard_amounts": [GiftCardAmounts],
  "giftcard_type": "VIRTUAL",
  "image": ProductImage,
  "is_redeemable": true,
  "is_returnable": "abc123",
  "lifetime": 987,
  "manufacturer": 123,
  "max_sale_qty": 987.65,
  "media_gallery": [MediaGalleryInterface],
  "message_max_length": 987,
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 987.65,
  "open_amount_max": 987.65,
  "open_amount_min": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "related_products": [ProductInterface],
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_price": 123.45,
  "special_to_date": "abc123",
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "uid": 4,
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "weight": 987.65
}

GiftCardRequisitionListItem

Contains details about gift cards added to a requisition list.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "gift_card_options": GiftCardOptions,
  "product": ProductInterface,
  "quantity": 987.65,
  "sku": "abc123",
  "uid": "4"
}

GiftCardShipmentItem

Fields

Example

{
  "gift_card": GiftCardItem,
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 123.45
}

GiftCardTypeEnum

Specifies the gift card type.

Values

Example

""VIRTUAL""

GiftCardWishlistItem

A single gift card added to a wish list.

Fields

Example

{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "abc123",
  "gift_card_options": GiftCardOptions,
  "id": 4,
  "product": ProductInterface,
  "quantity": 123.45
}

GiftMessage

Contains the text of a gift message, its sender, and recipient

Fields

Example

{
  "from": "xyz789",
  "message": "abc123",
  "to": "xyz789"
}

GiftMessageInput

Defines a gift message.

Input Fields

Example

{
  "from": "abc123",
  "message": "abc123",
  "to": "abc123"
}

GiftOptionsPrices

Contains prices for gift wrapping options.

Fields

Example

{
  "gift_wrapping_for_items": Money,
  "gift_wrapping_for_items_incl_tax": Money,
  "gift_wrapping_for_order": Money,
  "gift_wrapping_for_order_incl_tax": Money,
  "printed_card": Money,
  "printed_card_incl_tax": Money
}

GiftRegistry

Contains details about a gift registry.

Fields

Example

{
  "created_at": "abc123",
  "dynamic_attributes": [GiftRegistryDynamicAttribute],
  "event_name": "abc123",
  "items": [GiftRegistryItemInterface],
  "message": "xyz789",
  "owner_name": "abc123",
  "privacy_settings": "PRIVATE",
  "registrants": [GiftRegistryRegistrant],
  "shipping_address": CustomerAddress,
  "status": "ACTIVE",
  "type": GiftRegistryType,
  "uid": 4
}

GiftRegistryDynamicAttribute

Fields

Example

{
  "code": 4,
  "group": "EVENT_INFORMATION",
  "label": "xyz789",
  "value": "abc123"
}

GiftRegistryDynamicAttributeGroup

Defines the group type of a gift registry dynamic attribute.

Values

Example

""EVENT_INFORMATION""

GiftRegistryDynamicAttributeInput

Defines a dynamic attribute.

Input Fields

Example

{
  "code": "4",
  "value": "xyz789"
}

GiftRegistryDynamicAttributeInterface

Fields

Possible Types

Example

{
  "code": "4",
  "label": "xyz789",
  "value": "xyz789"
}

GiftRegistryDynamicAttributeMetadata

Fields

Example

{
  "attribute_group": "abc123",
  "code": 4,
  "input_type": "xyz789",
  "is_required": false,
  "label": "xyz789",
  "sort_order": 987
}

GiftRegistryDynamicAttributeMetadataInterface

Fields

Possible Types

Example

{
  "attribute_group": "abc123",
  "code": "4",
  "input_type": "abc123",
  "is_required": true,
  "label": "xyz789",
  "sort_order": 123
}

GiftRegistryItem

Fields

Example

{
  "created_at": "xyz789",
  "note": "abc123",
  "product": ProductInterface,
  "quantity": 987.65,
  "quantity_fulfilled": 123.45,
  "uid": "4"
}

GiftRegistryItemInterface

Fields

Possible Types

Example

{
  "created_at": "xyz789",
  "note": "xyz789",
  "product": ProductInterface,
  "quantity": 123.45,
  "quantity_fulfilled": 123.45,
  "uid": 4
}

GiftRegistryItemUserErrorInterface

Contains the status and any errors that encountered with the customer's gift register item.

Fields

Possible Types

Example

{
  "status": true,
  "user_errors": [GiftRegistryItemsUserError]
}

GiftRegistryItemsUserError

Contains details about an error that occurred when processing a gift registry item.

Fields

Example

{
  "code": "OUT_OF_STOCK",
  "gift_registry_item_uid": 4,
  "gift_registry_uid": 4,
  "message": "abc123",
  "product_uid": 4
}

GiftRegistryItemsUserErrorType

Defines the error type.

Values

Example

""OUT_OF_STOCK""

GiftRegistryOutputInterface

Contains the customer's gift registry.

Fields

Possible Types

Example

{"gift_registry": GiftRegistry}

GiftRegistryPrivacySettings

Defines the privacy setting of the gift registry.

Values

Example

""PRIVATE""

GiftRegistryRegistrant

Contains details about a registrant.

Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryRegistrantDynamicAttribute
  ],
  "email": "xyz789",
  "firstname": "abc123",
  "lastname": "abc123",
  "uid": "4"
}

GiftRegistryRegistrantDynamicAttribute

Fields

Example

{
  "code": 4,
  "label": "abc123",
  "value": "abc123"
}

GiftRegistrySearchResult

Contains the results of a gift registry search.

Fields

Example

{
  "event_date": "abc123",
  "event_title": "xyz789",
  "gift_registry_uid": "4",
  "location": "abc123",
  "name": "abc123",
  "type": "xyz789"
}

GiftRegistryShippingAddressInput

Defines a shipping address for a gift registry. Specify either address_data or the address_id. If both are provided, validation will fail.

Input Fields

Example

{
  "address_data": CustomerAddressInput,
  "address_id": 4,
  "customer_address_uid": "4"
}

GiftRegistryStatus

Defines the status of the gift registry.

Values

Example

""ACTIVE""

GiftRegistryType

Contains details about a gift registry type.

Fields

Example

{
  "dynamic_attributes_metadata": [
    GiftRegistryDynamicAttributeMetadataInterface
  ],
  "label": "abc123",
  "uid": 4
}

GiftWrapping

Contains details about the selected or available gift wrapping options.

Fields

Example

{
  "design": "abc123",
  "image": GiftWrappingImage,
  "price": Money,
  "uid": 4
}

GiftWrappingImage

Points to an image associated with a gift wrapping option.

Fields

Example

{
  "label": "xyz789",
  "url": "xyz789"
}

GooglePayButtonStyles

Fields

Example

{
  "color": "xyz789",
  "height": 123,
  "type": "abc123"
}

GooglePayConfig

Fields

Example

{
  "button_styles": GooglePayButtonStyles,
  "code": "xyz789",
  "is_visible": true,
  "payment_intent": "xyz789",
  "payment_source": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "three_ds_mode": "OFF",
  "title": "abc123"
}

GooglePayMethodInput

Google Pay inputs

Input Fields

Example

{
  "payment_source": "xyz789",
  "payments_order_id": "xyz789",
  "paypal_order_id": "xyz789"
}

GroupedProduct

Defines a grouped product, which consists of simple standalone products that are presented as a group.

Fields

Example

{
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "country_of_manufacture": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": false,
  "gift_wrapping_price": Money,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [GroupedProductItem],
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options_container": "abc123",
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "related_products": [ProductInterface],
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_price": 987.65,
  "special_to_date": "abc123",
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "uid": "4",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "weight": 123.45
}

GroupedProductItem

Contains information about an individual grouped product item.

Fields

Example

{
  "position": 987,
  "product": ProductInterface,
  "qty": 987.65
}

GroupedProductWishlistItem

A grouped product wish list item.

Fields

Example

{
  "added_at": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "product": ProductInterface,
  "quantity": 123.45
}

GuestOrderCancelInput

Input to retrieve a guest order based on token.

Input Fields

Example

{
  "reason": "xyz789",
  "token": "xyz789"
}

GuestOrderInformationInput

Input to retrieve an order based on details.

Input Fields

Example

{
  "email": "xyz789",
  "lastname": "xyz789",
  "number": "xyz789"
}

Highlight

An object that provides highlighted text for matched words

Fields

Example

{
  "attribute": "xyz789",
  "matched_words": ["abc123"],
  "value": "xyz789"
}

HistoryItemNoteData

Item note data that is added to the negotiable quote history object.

Fields

Example

{
  "created_at": "xyz789",
  "creator_name": "xyz789",
  "creator_type": "abc123",
  "item_id": 123,
  "note": "abc123",
  "product_name": "abc123"
}

HostedFieldsConfig

Fields

Example

{
  "cc_vault_code": "abc123",
  "code": "xyz789",
  "is_vault_enabled": false,
  "is_visible": false,
  "payment_intent": "xyz789",
  "payment_source": "abc123",
  "requires_card_details": true,
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "three_ds_mode": "OFF",
  "title": "xyz789"
}

HostedFieldsInput

Hosted Fields payment inputs

Input Fields

Example

{
  "cardBin": "xyz789",
  "cardExpiryMonth": "abc123",
  "cardExpiryYear": "xyz789",
  "cardLast4": "abc123",
  "holderName": "xyz789",
  "is_active_payment_token_enabler": false,
  "payment_source": "xyz789",
  "payments_order_id": "abc123",
  "paypal_order_id": "xyz789"
}

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"4"

ImageSwatchData

Fields

Example

{
  "thumbnail": "xyz789",
  "value": "xyz789"
}

ImportSharedRequisitionListOutput

Result of importing a shared requisition list.

Fields

Example

{
  "requisition_list": RequisitionList,
  "user_errors": [ShareRequisitionListUserError]
}

InputFilterEnum

List of templates/filters applied to customer attribute input.

Values

Example

""NONE""

InsufficientStockError

Fields

Example

{
  "code": "PRODUCT_NOT_FOUND",
  "message": "xyz789",
  "quantity": 987.65
}

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

123

InternalError

Contains an error message when an internal error occurred.

Fields

Example

{"message": "abc123"}

Invoice

Contains invoice details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "custom_attributes": [CustomAttribute],
  "id": "4",
  "items": [InvoiceItemInterface],
  "number": "abc123",
  "total": InvoiceTotal
}

InvoiceCustomAttributesInput

Defines an invoice custom attributes.

Input Fields

Example

{
  "custom_attributes": [CustomAttributeInput],
  "invoice_id": "xyz789"
}

InvoiceItem

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 987.65
}

InvoiceItemCustomAttributesInput

Defines an invoice item custom attributes.

Input Fields

Example

{
  "custom_attributes": [CustomAttributeInput],
  "invoice_id": "xyz789",
  "invoice_item_id": "xyz789"
}

InvoiceItemInterface

Contains detailes about invoiced items.

Fields

Possible Types

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_invoiced": 123.45
}

InvoiceOutput

Contains details about the invoice after adding custom attributes to it.

Fields

Example

{"invoice": Invoice}

InvoiceTotal

Contains price details from an invoice.

Fields

Example

{
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}

IsCompanyAdminEmailAvailableOutput

Contains the response of a company admin email validation query.

Fields

Example

{"is_email_available": false}

IsCompanyEmailAvailableOutput

Contains the response of a company email validation query.

Fields

Example

{"is_email_available": true}

IsCompanyRoleNameAvailableOutput

Contains the response of a role name validation query.

Fields

Example

{"is_role_name_available": false}

IsCompanyUserEmailAvailableOutput

Contains the response of a company user email validation query.

Fields

Example

{"is_email_available": false}

IsEmailAvailableOutput

Contains the result of the isEmailAvailable query.

Fields

Example

{"is_email_available": true}

IsOperatorInput

Input Fields

Example

{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true}

IsOperatorType

Values

Example

""UNKNOWN_ISOPERATOR_TYPE""

IsProductAlertSubscriptionResult

Fields

Example

{"isSubscribed": false, "message": "xyz789"}

ItemNote

The note object for quote line item.

Fields

Example

{
  "created_at": "abc123",
  "creator_id": 123,
  "creator_name": "abc123",
  "creator_type": 123,
  "negotiable_quote_item_uid": "4",
  "note": "abc123",
  "note_uid": 4
}

ItemSelectedBundleOption

A list of options of the selected bundle product.

Fields

Example

{
  "label": "abc123",
  "uid": 4,
  "values": [ItemSelectedBundleOptionValue]
}

ItemSelectedBundleOptionValue

A list of values for the selected bundle product.

Fields

Example

{
  "price": Money,
  "product_name": "abc123",
  "product_sku": "xyz789",
  "quantity": 987.65,
  "uid": 4
}

JSON

A JSON scalar

Example

{}

KeyValue

Contains a key-value pair.

Fields

Example

{
  "name": "xyz789",
  "value": "xyz789"
}

LineItemNoteInput

Sets quote item note.

Input Fields

Example

{
  "note": "abc123",
  "quote_item_uid": "4",
  "quote_uid": 4
}

MediaGalleryInterface

Contains basic information about a product image or video.

Fields

Possible Types

Example

{
  "disabled": true,
  "label": "xyz789",
  "position": 987,
  "url": "abc123"
}

MediaResourceType

Enumeration of media resource types

Values

Example

""NEGOTIABLE_QUOTE_ATTACHMENT""

MessageStyleLogo

Fields

Example

{"type": "abc123"}

MessageStyles

Fields

Example

{
  "layout": "xyz789",
  "logo": MessageStyleLogo
}

Money

Defines a monetary value, including a numeric value and a currency code.

Fields

Example

{"currency": "AFN", "value": 123.45}

MoveCartItemsToGiftRegistryOutput

Contains the customer's gift registry and any errors encountered.

Fields

Example

{
  "gift_registry": GiftRegistry,
  "status": true,
  "user_errors": [GiftRegistryItemsUserError]
}

MoveItemsBetweenRequisitionListsInput

An input object that defines the items in a requisition list to be moved.

Input Fields

Example

{"requisitionListItemUids": ["4"]}

MoveItemsBetweenRequisitionListsOutput

Output of the request to move items to another requisition list.

Fields

Example

{
  "destination_requisition_list": RequisitionList,
  "source_requisition_list": RequisitionList
}

MoveLineItemToRequisitionListInput

Move Line Item to Requisition List.

Input Fields

Example

{
  "quote_item_uid": "4",
  "quote_uid": 4,
  "requisition_list_uid": 4
}

MoveLineItemToRequisitionListOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

MoveProductsBetweenWishlistsOutput

Contains the source and target wish lists after moving products.

Fields

Example

{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

NegotiableQuote

Contains details about a negotiable quote.

Fields

Example

{
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": NegotiableQuoteBillingAddress,
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "created_at": "xyz789",
  "custom_attributes": [CustomAttribute],
  "email": "xyz789",
  "expiration_date": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "is_virtual": false,
  "items": [CartItemInterface],
  "name": "abc123",
  "order": CustomerOrder,
  "prices": CartPrices,
  "sales_rep_name": "xyz789",
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "SUBMITTED",
  "template_id": "4",
  "template_name": "xyz789",
  "total_quantity": 987.65,
  "uid": "4",
  "updated_at": "abc123"
}

NegotiableQuoteAddressCountry

Defines the company's country.

Fields

Example

{
  "code": "abc123",
  "label": "abc123"
}

NegotiableQuoteAddressInput

Defines the billing or shipping address to be applied to the cart.

Input Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "xyz789",
  "custom_attributes": [AttributeValueInput],
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": "xyz789",
  "region_id": 987,
  "save_in_address_book": true,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "vat_id": "abc123"
}

NegotiableQuoteAddressInterface

Fields

Possible Types

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": 4,
  "fax": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "uid": 4,
  "vat_id": "xyz789"
}

NegotiableQuoteAddressRegion

Defines the company's state or province.

Fields

Example

{
  "code": "xyz789",
  "label": "abc123",
  "region_id": 987
}

NegotiableQuoteBillingAddress

Fields

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": 4,
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "xyz789",
  "uid": 4,
  "vat_id": "xyz789"
}

NegotiableQuoteBillingAddressInput

Defines the billing address.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": "4",
  "same_as_shipping": false,
  "use_for_shipping": true
}

NegotiableQuoteComment

Contains a single plain text comment from either the buyer or seller.

Fields

Example

{
  "attachments": [NegotiableQuoteCommentAttachment],
  "author": NegotiableQuoteUser,
  "created_at": "abc123",
  "creator_type": "BUYER",
  "text": "abc123",
  "uid": 4
}

NegotiableQuoteCommentAttachment

Negotiable quote comment file attachment.

Fields

Example

{
  "name": "abc123",
  "url": "xyz789"
}

NegotiableQuoteCommentAttachmentInput

Negotiable quote comment file attachment.

Input Fields

Example

{"key": "abc123"}

NegotiableQuoteCommentCreatorType

Values

Example

""BUYER""

NegotiableQuoteCommentInput

Contains the commend provided by the buyer.

Input Fields

Example

{
  "attachments": [NegotiableQuoteCommentAttachmentInput],
  "comment": "abc123"
}

NegotiableQuoteCustomLogChange

Contains custom log entries added by third-party extensions.

Fields

Example

{
  "new_value": "xyz789",
  "old_value": "abc123",
  "title": "abc123"
}

NegotiableQuoteFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Example

{
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput
}

NegotiableQuoteHistoryChanges

Contains a list of changes to a negotiable quote.

Fields

Example

{
  "comment_added": NegotiableQuoteHistoryCommentChange,
  "custom_changes": NegotiableQuoteCustomLogChange,
  "expiration": NegotiableQuoteHistoryExpirationChange,
  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
  "statuses": NegotiableQuoteHistoryStatusesChange,
  "total": NegotiableQuoteHistoryTotalChange
}

NegotiableQuoteHistoryCommentChange

Contains a comment submitted by a seller or buyer.

Fields

Example

{"comment": "abc123"}

NegotiableQuoteHistoryEntry

Contains details about a change for a negotiable quote.

Fields

Example

{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteHistoryChanges,
  "created_at": "xyz789",
  "item_note": HistoryItemNoteData,
  "uid": 4
}

NegotiableQuoteHistoryEntryChangeType

Values

Example

""CREATED""

NegotiableQuoteHistoryExpirationChange

Contains a new expiration date and the previous date.

Fields

Example

{
  "new_expiration": "abc123",
  "old_expiration": "xyz789"
}

NegotiableQuoteHistoryProductsRemovedChange

Contains lists of products that have been removed from the catalog and negotiable quote.

Fields

Example

{
  "products_removed_from_catalog": ["4"],
  "products_removed_from_quote": [ProductInterface]
}

NegotiableQuoteHistoryStatusChange

Lists a new status change applied to a negotiable quote and the previous status.

Fields

Example

{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}

NegotiableQuoteHistoryStatusesChange

Contains a list of status changes that occurred for the negotiable quote.

Fields

Example

{"changes": [NegotiableQuoteHistoryStatusChange]}

NegotiableQuoteHistoryTotalChange

Contains a new price and the previous price.

Fields

Example

{
  "new_price": Money,
  "old_price": Money
}

NegotiableQuoteInvalidStateError

An error indicating that an operation was attempted on a negotiable quote in an invalid state.

Fields

Example

{"message": "abc123"}

NegotiableQuoteItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

{"quantity": 123.45, "quote_item_uid": 4}

NegotiableQuotePaymentMethodInput

Defines the payment method to be applied to the negotiable quote.

Input Fields

Example

{
  "code": "abc123",
  "purchase_order_number": "xyz789"
}

NegotiableQuoteReferenceDocumentLink

Contains a reference document link for a negotiable quote template.

Fields

Example

{
  "document_identifier": "xyz789",
  "document_name": "xyz789",
  "link_id": "4",
  "reference_document_url": "xyz789"
}

NegotiableQuoteShippingAddress

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "abc123",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["xyz789"],
  "suffix": "xyz789",
  "telephone": "xyz789",
  "uid": 4,
  "vat_id": "abc123"
}

NegotiableQuoteShippingAddressInput

Defines shipping addresses for the negotiable quote.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": "4",
  "customer_notes": "xyz789"
}

NegotiableQuoteSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Example

{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"}

NegotiableQuoteSortableField

Values

Example

""QUOTE_NAME""

NegotiableQuoteStatus

Values

Example

""SUBMITTED""

NegotiableQuoteTemplate

Contains details about a negotiable quote template.

Fields

Example

{
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "created_at": "xyz789",
  "expiration_date": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "historyV2": [NegotiableQuoteTemplateHistoryEntry],
  "is_min_max_qty_used": true,
  "is_virtual": true,
  "items": [CartItemInterface],
  "max_order_commitment": 987,
  "min_order_commitment": 987,
  "name": "abc123",
  "notifications": [QuoteTemplateNotificationMessage],
  "prices": CartPrices,
  "reference_document_links": [
    NegotiableQuoteReferenceDocumentLink
  ],
  "sales_rep_name": "xyz789",
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "xyz789",
  "template_id": "4",
  "total_quantity": 987.65,
  "uid": 4,
  "updated_at": "abc123"
}

NegotiableQuoteTemplateFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Example

{
  "state": FilterEqualTypeInput,
  "status": FilterEqualTypeInput
}

NegotiableQuoteTemplateGridItem

Contains data for a negotiable quote template in a grid.

Fields

Example

{
  "activated_at": "abc123",
  "company_name": "abc123",
  "created_at": "abc123",
  "expiration_date": "abc123",
  "is_min_max_qty_used": false,
  "last_ordered_at": "abc123",
  "last_shared_at": "xyz789",
  "max_order_commitment": 987,
  "min_negotiated_grand_total": 987.65,
  "min_order_commitment": 123,
  "name": "abc123",
  "orders_placed": 987,
  "prices": CartPrices,
  "sales_rep_name": "abc123",
  "state": "abc123",
  "status": "xyz789",
  "submitted_by": "xyz789",
  "template_id": 4,
  "uid": 4,
  "updated_at": "xyz789"
}

NegotiableQuoteTemplateHistoryChanges

Contains a list of changes to a negotiable quote template.

Fields

Example

{
  "comment_added": NegotiableQuoteHistoryCommentChange,
  "custom_changes": NegotiableQuoteCustomLogChange,
  "expiration": NegotiableQuoteHistoryExpirationChange,
  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
  "statuses": NegotiableQuoteTemplateHistoryStatusesChange,
  "total": NegotiableQuoteHistoryTotalChange
}