CustomerAddress

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

Fields

Example

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

CustomerAddressAttribute

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

Fields

Example

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

CustomerAddressAttributeInput

Specifies the attribute code and value of a customer attribute.

Input Fields

Example

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

CustomerAddressInput

Contains details about a billing or shipping address.

Input Fields

Example

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

CustomerAddressRegion

Defines the customer's state or province.

Fields

Example

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

CustomerAddressRegionInput

Defines the customer's state or province.

Input Fields

Example

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

CustomerAttributeMetadata

Customer attribute metadata.

Fields

Example

{
  "code": 4,
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "xyz789",
  "frontend_input": "BOOLEAN",
  "input_filter": "NONE",
  "is_required": true,
  "is_unique": true,
  "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": "xyz789",
  "dob": "xyz789",
  "email": "xyz789",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "abc123",
  "middlename": "abc123",
  "password": "xyz789",
  "prefix": "xyz789",
  "suffix": "xyz789",
  "taxvat": "xyz789"
}

CustomerDownloadableProduct

Contains details about a single downloadable product.

Fields

Example

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

CustomerDownloadableProducts

Contains a list of downloadable products.

Fields

Example

{"items": [CustomerDownloadableProduct]}

CustomerInput

An input object that assigns or updates customer attributes.

Input Fields

Example

{
  "date_of_birth": "xyz789",
  "dob": "abc123",
  "email": "xyz789",
  "firstname": "xyz789",
  "gender": 123,
  "is_subscribed": true,
  "lastname": "abc123",
  "middlename": "xyz789",
  "password": "abc123",
  "prefix": "abc123",
  "suffix": "xyz789",
  "taxvat": "abc123"
}

CustomerOrder

Contains details about each of the customer's orders.

Fields

Example

{
  "applied_coupons": [AppliedCoupon],
  "billing_address": OrderAddress,
  "carrier": "xyz789",
  "comments": [SalesCommentItem],
  "created_at": "abc123",
  "credit_memos": [CreditMemo],
  "email": "xyz789",
  "gift_message": GiftMessage,
  "gift_receipt_included": false,
  "gift_wrapping": GiftWrapping,
  "grand_total": 987.65,
  "id": "4",
  "increment_id": "abc123",
  "invoices": [Invoice],
  "items": [OrderItemInterface],
  "items_eligible_for_return": [OrderItemInterface],
  "number": "xyz789",
  "order_date": "abc123",
  "order_number": "xyz789",
  "payment_methods": [OrderPaymentMethod],
  "printed_card_included": false,
  "returns": Returns,
  "shipments": [OrderShipment],
  "shipping_address": OrderAddress,
  "shipping_method": "xyz789",
  "status": "abc123",
  "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

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

CustomerOrdersFilterInput

Identifies the filter to use for filtering orders.

Input Fields

Example

{"number": FilterStringTypeInput}

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]}

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": 123
}

CustomerStoreCreditHistoryItem

Contains store credit history information.

Fields

Example

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

CustomerToken

Contains a customer authorization token.

Fields

Example

{"token": "abc123"}

CustomerUpdateInput

An input object for updating a customer.

Input Fields

Example

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

CustomizableAreaOption

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

Fields

Example

{
  "option_id": 123,
  "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": 987,
  "price": 987.65,
  "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

{
  "option_id": 123,
  "required": false,
  "sort_order": 123,
  "title": "abc123",
  "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": 123,
  "title": "abc123",
  "uid": 4
}

CustomizableDateOption

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

Fields

Example

{
  "option_id": 987,
  "product_sku": "abc123",
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "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": 123.45,
  "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

{
  "option_id": 987,
  "required": true,
  "sort_order": 123,
  "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": "xyz789",
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4
}

CustomizableFieldOption

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

Fields

Example

{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 987,
  "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": 987,
  "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

{
  "option_id": 987,
  "product_sku": "abc123",
  "required": false,
  "sort_order": 123,
  "title": "xyz789",
  "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": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": 4
}

CustomizableMultipleOption

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

Fields

Example

{
  "option_id": 123,
  "required": false,
  "sort_order": 987,
  "title": "xyz789",
  "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": "xyz789",
  "uid": 4
}

CustomizableOptionInput

Defines a customizable option.

Input Fields

Example

{
  "id": 987,
  "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

{
  "option_id": 123,
  "required": false,
  "sort_order": 123,
  "title": "xyz789",
  "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

{
  "option_id": 123,
  "required": true,
  "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": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "xyz789",
  "uid": "4"
}

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": false, "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": "abc123",
  "type": "abc123",
  "value": 987.65
}

DownloadableCartItem

An implementation for downloadable product cart items.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "abc123",
  "is_available": false,
  "links": [DownloadableProductLinks],
  "max_qty": 123.45,
  "min_qty": 123.45,
  "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

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

DownloadableFileTypeEnum

Values

Example

""FILE""

DownloadableInvoiceItem

Defines downloadable product options for InvoiceItemInterface.

Fields

Example

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

DownloadableItemsLinks

Defines characteristics of the links for downloadable product.

Fields

Example

{
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4
}

DownloadableOrderItem

Defines downloadable product options for OrderItemInterface.

Fields

Example

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

DownloadableProduct

Defines a product that the shopper downloads.

Fields

Example

{
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "downloadable_product_links": [
    DownloadableProductLinks
  ],
  "downloadable_product_samples": [
    DownloadableProductSamples
  ],
  "gift_message_available": "xyz789",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "links_purchased_separately": 987,
  "links_title": "xyz789",
  "manufacturer": 987,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "abc123",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 987,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "abc123",
  "staged": false,
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": 4,
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

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

{
  "id": 987,
  "is_shareable": true,
  "link_type": "FILE",
  "number_of_downloads": 123,
  "price": 987.65,
  "sample_file": "xyz789",
  "sample_type": "FILE",
  "sample_url": "abc123",
  "sort_order": 123,
  "title": "abc123",
  "uid": "4"
}

DownloadableProductLinksInput

Contains the link ID for the downloadable product.

Input Fields

Example

{"link_id": 123}

DownloadableProductSamples

Defines characteristics of a downloadable product.

Fields

Example

{
  "id": 987,
  "sample_file": "xyz789",
  "sample_type": "FILE",
  "sample_url": "abc123",
  "sort_order": 987,
  "title": "abc123"
}

DownloadableRequisitionListItem

Contains details about downloadable products added to a requisition list.

Fields

Example

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

DownloadableWishlistItem

A downloadable product wish list item.

Fields

Example

{
  "added_at": "abc123",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": "4",
  "links_v2": [DownloadableProductLinks],
  "product": ProductInterface,
  "quantity": 123.45,
  "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}

DynamicBlock

Contains a single dynamic block.

Fields

Example

{
  "content": ComplexTextValue,
  "uid": "4"
}

DynamicBlockLocationEnum

Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations.

Values

Example

""CONTENT""

DynamicBlockTypeEnum

Indicates the selected Dynamic Blocks Rotator inline widget.

Values

Example

""SPECIFIED""

DynamicBlocks

Contains an array of dynamic blocks.

Fields

Example

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

DynamicBlocksFilterInput

Defines the dynamic block filter. The filter can identify the block type, location and IDs to return.

Input Fields

Example

{
  "dynamic_block_uids": ["4"],
  "locations": ["CONTENT"],
  "type": "SPECIFIED"
}

EnteredCustomAttributeInput

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

Input Fields

Example

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

EnteredOptionInput

Defines a customer-entered option.

Input Fields

Example

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

EntityUrl

Contains the uid, relative_url, and type attributes.

Fields

Example

{
  "canonical_url": "abc123",
  "entity_uid": "4",
  "id": 123,
  "redirectCode": 987,
  "relative_url": "abc123",
  "type": "CMS_PAGE"
}

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}

ExchangeRate

Lists the exchange rate.

Fields

Example

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

FilterEqualTypeInput

Defines a filter that matches the input exactly.

Input Fields

Example

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

FilterMatchTypeEnum

Values

Example

""FULL""

FilterMatchTypeInput

Defines a filter that performs a fuzzy search.

Input Fields

Example

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

FilterRangeTypeInput

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

Input Fields

Example

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

FilterStringTypeInput

Defines a filter for an input string.

Input Fields

Example

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

FilterTypeInput

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

Input Fields

Example

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

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": "xyz789"}

GenerateCustomerTokenAsAdminOutput

Contains the generated customer token.

Fields

Example

{"customer_token": "xyz789"}

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": "xyz789"
}

GiftCardAccountInput

Contains the gift card code.

Input Fields

Example

{"gift_card_code": "abc123"}

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,
  "value_id": 987,
  "website_id": 123,
  "website_value": 987.65
}

GiftCardCartItem

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

Fields

Example

{
  "amount": Money,
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "abc123",
  "is_available": false,
  "max_qty": 123.45,
  "message": "abc123",
  "min_qty": 987.65,
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "recipient_email": "xyz789",
  "recipient_name": "xyz789",
  "sender_email": "abc123",
  "sender_name": "abc123",
  "uid": 4
}

GiftCardCreditMemoItem

Fields

Example

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

GiftCardInvoiceItem

Fields

Example

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

GiftCardItem

Contains details about a gift card.

Fields

Example

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

GiftCardOptions

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

Fields

Example

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

GiftCardOrderItem

Fields

Example

{
  "discounts": [Discount],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_card": GiftCardItem,
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "abc123",
  "product_url_key": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 987.65,
  "quantity_refunded": 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": false,
  "allow_open_amount": false,
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_card_options": [CustomizableOptionInterface],
  "gift_message_available": "abc123",
  "giftcard_amounts": [GiftCardAmounts],
  "giftcard_type": "VIRTUAL",
  "id": 987,
  "image": ProductImage,
  "is_redeemable": true,
  "is_returnable": "abc123",
  "lifetime": 987,
  "manufacturer": 987,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "message_max_length": 123,
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "abc123",
  "new_from_date": "xyz789",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "open_amount_max": 123.45,
  "open_amount_min": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 123,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website],
  "weight": 123.45
}

GiftCardRequisitionListItem

Contains details about gift cards added to a requisition list.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "gift_card_options": GiftCardOptions,
  "product": ProductInterface,
  "quantity": 123.45,
  "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": "xyz789",
  "gift_card_options": GiftCardOptions,
  "id": "4",
  "product": ProductInterface,
  "quantity": 987.65
}

GiftMessage

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

Fields

Example

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

GiftMessageInput

Defines a gift message.

Input Fields

Example

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

GiftOptionsPrices

Contains prices for gift wrapping options.

Fields

Example

{
  "gift_wrapping_for_items": Money,
  "gift_wrapping_for_order": Money,
  "printed_card": Money
}

GiftRegistry

Contains details about a gift registry.

Fields

Example

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

GiftRegistryDynamicAttribute

Fields

Example

{
  "code": 4,
  "group": "EVENT_INFORMATION",
  "label": "abc123",
  "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": "abc123"
}

GiftRegistryDynamicAttributeInterface

Fields

Possible Types

Example

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

GiftRegistryDynamicAttributeMetadata

Fields

Example

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

GiftRegistryDynamicAttributeMetadataInterface

Fields

Possible Types

Example

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

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": "abc123",
  "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": "abc123",
  "firstname": "xyz789",
  "lastname": "xyz789",
  "uid": 4
}

GiftRegistryRegistrantDynamicAttribute

Fields

Example

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

GiftRegistrySearchResult

Contains the results of a gift registry search.

Fields

Example

{
  "event_date": "xyz789",
  "event_title": "xyz789",
  "gift_registry_uid": 4,
  "location": "abc123",
  "name": "xyz789",
  "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}

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": "xyz789",
  "uid": 4
}

GiftWrapping

Contains details about the selected or available gift wrapping options.

Fields

Example

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

GiftWrappingImage

Points to an image associated with a gift wrapping option.

Fields

Example

{
  "label": "abc123",
  "url": "abc123"
}

GooglePayButtonStyles

Fields

Example

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

GooglePayConfig

Fields

Example

{
  "button_styles": GooglePayButtonStyles,
  "code": "abc123",
  "is_visible": true,
  "payment_intent": "abc123",
  "payment_source": "xyz789",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "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

{
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": "abc123",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [GroupedProductItem],
  "manufacturer": 123,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "xyz789",
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options_container": "xyz789",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 987.65,
  "special_to_date": "abc123",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": 4,
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website],
  "weight": 123.45
}

GroupedProductItem

Contains information about an individual grouped product item.

Fields

Example

{
  "position": 123,
  "product": ProductInterface,
  "qty": 123.45
}

GroupedProductWishlistItem

A grouped product wish list item.

Fields

Example

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

HostedFieldsConfig

Fields

Example

{
  "cc_vault_code": "xyz789",
  "code": "abc123",
  "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": false,
  "title": "xyz789"
}

HostedFieldsInput

Hosted Fields payment inputs

Input Fields

Example

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

HostedProInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payments Pro Hosted Solution payment method.

Input Fields

Example

{
  "cancel_url": "xyz789",
  "return_url": "abc123"
}

HostedProUrl

Contains the secure URL used for the Payments Pro Hosted Solution payment method.

Fields

Example

{"secure_form_url": "xyz789"}

HostedProUrlInput

Contains the required input to request the secure URL for Payments Pro Hosted Solution payment.

Input Fields

Example

{"cart_id": "abc123"}

HttpQueryParameter

Contains target path parameters.

Fields

Example

{
  "name": "abc123",
  "value": "abc123"
}

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"
}

InputFilterEnum

List of templates/filters applied to customer attribute input.

Values

Example

""NONE""

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": "xyz789"}

Invoice

Contains invoice details.

Fields

Example

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

InvoiceItem

Fields

Example

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

InvoiceItemInterface

Contains detailes about invoiced items.

Fields

Possible Types

Example

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

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": true}

IsCompanyEmailAvailableOutput

Contains the response of a company email validation query.

Fields

Example

{"is_email_available": false}

IsCompanyRoleNameAvailableOutput

Contains the response of a role name validation query.

Fields

Example

{"is_role_name_available": true}

IsCompanyUserEmailAvailableOutput

Contains the response of a company user email validation query.

Fields

Example

{"is_email_available": true}

IsEmailAvailableOutput

Contains the result of the isEmailAvailable query.

Fields

Example

{"is_email_available": true}

ItemNote

The note object for quote line item.

Fields

Example

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

ItemSelectedBundleOption

A list of options of the selected bundle product.

Fields

Example

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

ItemSelectedBundleOptionValue

A list of values for the selected bundle product.

Fields

Example

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

KeyValue

Contains a key-value pair.

Fields

Example

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

LayerFilter

Contains information for rendering layered navigation.

Fields

Example

{
  "filter_items": [LayerFilterItemInterface],
  "filter_items_count": 123,
  "name": "xyz789",
  "request_var": "xyz789"
}

LayerFilterItem

Fields

Example

{
  "items_count": 123,
  "label": "abc123",
  "value_string": "abc123"
}

LayerFilterItemInterface

Fields

Possible Types

Example

{
  "items_count": 987,
  "label": "xyz789",
  "value_string": "abc123"
}

LineItemNoteInput

Sets quote item note.

Input Fields

Example

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

MediaGalleryEntry

Defines characteristics about images and videos associated with a specific product.

Fields

Example

{
  "content": ProductMediaGalleryEntriesContent,
  "disabled": false,
  "file": "xyz789",
  "id": 987,
  "label": "abc123",
  "media_type": "xyz789",
  "position": 123,
  "types": ["abc123"],
  "uid": "4",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

MediaGalleryInterface

Contains basic information about a product image or video.

Fields

Possible Types

Example

{
  "disabled": false,
  "label": "abc123",
  "position": 987,
  "url": "abc123"
}

MessageStyleLogo

Fields

Example

{"type": "xyz789"}

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": false,
  "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",
  "email": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "is_virtual": false,
  "items": [CartItemInterface],
  "name": "abc123",
  "prices": CartPrices,
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "SUBMITTED",
  "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": "xyz789",
  "country_code": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123",
  "postcode": "abc123",
  "region": "xyz789",
  "region_id": 987,
  "save_in_address_book": false,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteAddressInterface

Fields

Possible Types

Example

{
  "city": "abc123",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "abc123",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteAddressRegion

Defines the company's state or province.

Fields

Example

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

NegotiableQuoteBillingAddress

Fields

Example

{
  "city": "abc123",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123"
}

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

{
  "author": NegotiableQuoteUser,
  "created_at": "xyz789",
  "creator_type": "BUYER",
  "text": "xyz789",
  "uid": "4"
}

NegotiableQuoteCommentCreatorType

Values

Example

""BUYER""

NegotiableQuoteCommentInput

Contains the commend provided by the buyer.

Input Fields

Example

{"comment": "xyz789"}

NegotiableQuoteCustomLogChange

Contains custom log entries added by third-party extensions.

Fields

Example

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

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": "xyz789"}

NegotiableQuoteHistoryEntry

Contains details about a change for a negotiable quote.

Fields

Example

{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteHistoryChanges,
  "created_at": "abc123",
  "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": 987.65, "quote_item_uid": "4"}

NegotiableQuotePaymentMethodInput

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

Input Fields

Example

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

NegotiableQuoteShippingAddress

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "xyz789",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "abc123",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "telephone": "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],
  "expiration_date": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "is_min_max_qty_used": false,
  "is_virtual": true,
  "items": [CartItemInterface],
  "max_order_commitment": 123,
  "min_order_commitment": 987,
  "name": "abc123",
  "notifications": [QuoteTemplateNotificationMessage],
  "prices": CartPrices,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "xyz789",
  "template_id": 4,
  "total_quantity": 987.65
}

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": "xyz789",
  "expiration_date": "abc123",
  "is_min_max_qty_used": false,
  "last_shared_at": "xyz789",
  "max_order_commitment": 987,
  "min_negotiated_grand_total": 123.45,
  "min_order_commitment": 987,
  "name": "xyz789",
  "orders_placed": 987,
  "sales_rep_name": "xyz789",
  "state": "xyz789",
  "status": "xyz789",
  "submitted_by": "abc123",
  "template_id": "4"
}

NegotiableQuoteTemplateItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

{
  "item_id": "4",
  "max_qty": 987.65,
  "min_qty": 123.45,
  "quantity": 987.65
}

NegotiableQuoteTemplateShippingAddressInput

Defines shipping addresses for the negotiable quote template.

Input Fields

Example

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

NegotiableQuoteTemplateSortInput

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

Input Fields

Example

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

NegotiableQuoteTemplateSortableField

Values

Example

""TEMPLATE_ID""

NegotiableQuoteTemplatesOutput

Contains a list of negotiable templates that match the specified filter.

Fields

Example

{
  "items": [NegotiableQuoteTemplateGridItem],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 123
}

NegotiableQuoteUidNonFatalResultInterface

Fields

Possible Types

Example

{"quote_uid": 4}

NegotiableQuoteUidOperationSuccess

Contains details about a successful operation on a negotiable quote.

Fields

Example

{"quote_uid": 4}

NegotiableQuoteUser

A limited view of a Buyer or Seller in the negotiable quote process.

Fields

Example

{
  "firstname": "abc123",
  "lastname": "abc123"
}

NegotiableQuotesOutput

Contains a list of negotiable that match the specified filter.

Fields

Example

{
  "items": [NegotiableQuote],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 987
}

NoSuchEntityUidError

Contains an error message when an invalid UID was specified.

Fields

Example

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

OpenNegotiableQuoteTemplateInput

Specifies the quote template id to open quote template.

Input Fields

Example

{"template_id": 4}

Order

Contains the order ID.

Fields

Example

{
  "order_id": "xyz789",
  "order_number": "abc123"
}

OrderAddress

Contains detailed information about an order's billing and shipping addresses.

Fields

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "AF",
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "abc123",
  "postcode": "xyz789",
  "prefix": "abc123",
  "region": "xyz789",
  "region_id": "4",
  "street": ["xyz789"],
  "suffix": "xyz789",
  "telephone": "xyz789",
  "vat_id": "abc123"
}

OrderInformationInput

Input to retrieve an order based on details.

Input Fields

Example

{
  "email": "abc123",
  "number": "xyz789",
  "postcode": "xyz789"
}