NegotiableQuoteTemplateHistoryEntry

Contains details about a change for a negotiable quote template.

Fields

Example

{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteTemplateHistoryChanges,
  "created_at": "abc123",
  "uid": "4"
}

NegotiableQuoteTemplateHistoryStatusChange

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

Fields

Example

{
  "new_status": "xyz789",
  "old_status": "xyz789"
}

NegotiableQuoteTemplateHistoryStatusesChange

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

Fields

Example

{"changes": [NegotiableQuoteTemplateHistoryStatusChange]}

NegotiableQuoteTemplateItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

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

NegotiableQuoteTemplateReferenceDocumentLinkInput

Defines the reference document link to add to a negotiable quote template.

Input Fields

Example

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

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

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

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

NumericOperatorInput

Input Fields

Example

{"type": "UNKNOWN_NUMERIC_OPERATOR"}

NumericOperatorType

Values

Example

""UNKNOWN_NUMERIC_OPERATOR""

OopePaymentMethodConfig

Fields

Example

{
  "backend_integration_url": "abc123",
  "custom_config": [CustomConfigKeyValue]
}

OpenNegotiableQuoteTemplateInput

Specifies the quote template id to open quote template.

Input Fields

Example

{"template_id": "4"}

OperatorInput

Input Fields

Example

{
  "rangeOperator": RangeOperatorInput,
  "customOperator": CustomOperatorInput,
  "isOperator": IsOperatorInput,
  "numericOperator": NumericOperatorInput,
  "stringOperator": StringOperatorInput
}

Order

Contains the order ID.

Fields

Example

{"order_number": "abc123"}

OrderActionType

The list of available order actions.

Values

Example

""REORDER""

OrderAddress

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

Fields

Example

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

OrderCustomerInfo

Fields

Example

{
  "firstname": "abc123",
  "lastname": "abc123",
  "middlename": "xyz789",
  "prefix": "abc123",
  "suffix": "abc123"
}

OrderItem

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "discounts": [Discount],
  "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": "abc123",
  "product_type": "abc123",
  "product_url_key": "abc123",
  "quantity_canceled": 987.65,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 987.65,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 987.65,
  "quantity_returned": 123.45,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

OrderItemInterface

Order item details.

Fields

Possible Types

Example

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

OrderItemOption

Represents order item options like selected or entered.

Fields

Example

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

OrderItemPrices

Fields

Example

{
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "original_price": Money,
  "original_price_including_tax": Money,
  "original_row_total": Money,
  "original_row_total_including_tax": Money,
  "price": Money,
  "price_including_tax": Money,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

OrderPaymentMethod

Contains details about the payment method used to pay for the order.

Fields

Example

{
  "additional_data": [KeyValue],
  "name": "abc123",
  "type": "xyz789"
}

OrderShipment

Contains order shipment details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [ShipmentItemInterface],
  "number": "abc123",
  "tracking": [ShipmentTracking]
}

OrderTokenInput

Input to retrieve an order based on token.

Input Fields

Example

{"token": "abc123"}

OrderTotal

Contains details about the sales total amounts used to calculate the final price.

Fields

Example

{
  "base_grand_total": Money,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excl_tax": Money,
  "shipping_handling": ShippingHandling,
  "subtotal_excl_tax": Money,
  "subtotal_incl_tax": Money,
  "taxes": [TaxItem],
  "total_giftcard": Money,
  "total_reward_points": Money,
  "total_shipping": Money,
  "total_store_credit": Money,
  "total_tax": Money
}

PageInfo

Provides pagination information for navigating through paginated result sets.

Fields

Example

{"currentPage": 987, "pageSize": 987, "totalPages": 123}

PageType

Type of page on which recommendations are requested

Values

Example

""CMS""

PaymentAttributeInput

Defines the payment attribute.

Input Fields

Example

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

PaymentConfigItem

Contains payment fields that are common to all types of payment methods.

Fields

Possible Types

Example

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

PaymentConfigOutput

Retrieves the payment configuration for a given location

Fields

Example

{
  "apple_pay": ApplePayConfig,
  "fastlane": FastlaneConfig,
  "google_pay": GooglePayConfig,
  "hosted_fields": HostedFieldsConfig,
  "smart_buttons": SmartButtonsConfig
}

PaymentLocation

Defines the origin location for that payment request

Values

Example

""PRODUCT_DETAIL""

PaymentMethodInput

Defines the payment method.

Input Fields

Example

{
  "additional_data": [PaymentAttributeInput],
  "code": "xyz789",
  "payment_services_paypal_apple_pay": ApplePayMethodInput,
  "payment_services_paypal_fastlane": FastlaneMethodInput,
  "payment_services_paypal_google_pay": GooglePayMethodInput,
  "payment_services_paypal_hosted_fields": HostedFieldsInput,
  "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
  "payment_services_paypal_vault": VaultMethodInput,
  "purchase_order_number": "xyz789"
}

PaymentOrderOutput

Contains the payment order details

Fields

Example

{
  "id": "abc123",
  "mp_order_id": "abc123",
  "payment_source_details": PaymentSourceDetails,
  "status": "abc123"
}

PaymentSDKParamsItem

Fields

Example

{
  "code": "xyz789",
  "params": [SDKParams]
}

PaymentSourceDetails

Fields

Example

{"card": Card}

PaymentSourceInput

The payment source information

Input Fields

Example

{"card": CardPaymentSourceInput}

PaymentSourceOutput

The payment source information

Fields

Example

{"card": CardPaymentSourceOutput}

PaymentToken

The stored payment method available to the customer.

Fields

Example

{
  "details": "abc123",
  "payment_method_code": "xyz789",
  "public_hash": "xyz789",
  "type": "card"
}

PaymentTokenTypeEnum

The list of available payment token types.

Values

Example

""card""

PhysicalProductInterface

Contains attributes specific to tangible products.

Fields

Possible Types

Example

{"weight": 987.65}

PickupLocation

Defines Pickup Location information.

Fields

Example

{
  "city": "xyz789",
  "contact_name": "xyz789",
  "country_id": "abc123",
  "description": "xyz789",
  "email": "xyz789",
  "fax": "xyz789",
  "latitude": 123.45,
  "longitude": 123.45,
  "name": "xyz789",
  "phone": "xyz789",
  "pickup_location_code": "abc123",
  "postcode": "xyz789",
  "region": "abc123",
  "region_id": 987,
  "street": "xyz789"
}

PickupLocationFilterInput

PickupLocationFilterInput defines the list of attributes and filters for the search.

Input Fields

Example

{
  "city": FilterTypeInput,
  "country_id": FilterTypeInput,
  "name": FilterTypeInput,
  "pickup_location_code": FilterTypeInput,
  "postcode": FilterTypeInput,
  "region": FilterTypeInput,
  "region_id": FilterTypeInput,
  "street": FilterTypeInput
}

PickupLocationSortInput

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

Input Fields

Example

{
  "city": "ASC",
  "contact_name": "ASC",
  "country_id": "ASC",
  "description": "ASC",
  "distance": "ASC",
  "email": "ASC",
  "fax": "ASC",
  "latitude": "ASC",
  "longitude": "ASC",
  "name": "ASC",
  "phone": "ASC",
  "pickup_location_code": "ASC",
  "postcode": "ASC",
  "region": "ASC",
  "region_id": "ASC",
  "street": "ASC"
}

PickupLocations

Top level object returned in a pickup locations search.

Fields

Example

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

PlaceNegotiableQuoteOrderInput

Specifies the negotiable quote to convert to an order.

Input Fields

Example

{"quote_uid": 4}

PlaceNegotiableQuoteOrderOutput

An output object that returns the generated order.

Fields

Example

{"order": Order}

PlaceNegotiableQuoteOrderOutputV2

An output object that returns the generated order.

Fields

Example

{
  "errors": [PlaceOrderError],
  "order": CustomerOrder
}

PlaceOrderError

An error encountered while placing an order.

Fields

Example

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

PlaceOrderErrorCodes

Values

Example

""CART_NOT_FOUND""

PlaceOrderForPurchaseOrderInput

Specifies the purchase order to convert to an order.

Input Fields

Example

{"purchase_order_uid": 4}

PlaceOrderForPurchaseOrderOutput

Contains the results of the request to place an order.

Fields

Example

{"order": CustomerOrder}

PlaceOrderInput

Specifies the quote to be converted to an order.

Input Fields

Example

{"cart_id": "xyz789"}

PlaceOrderOutput

Contains the results of the request to place an order.

Fields

Example

{
  "errors": [PlaceOrderError],
  "orderV2": CustomerOrder
}

PlacePurchaseOrderInput

Specifies the quote to be converted to a purchase order.

Input Fields

Example

{"cart_id": "xyz789"}

PlacePurchaseOrderOutput

Contains the results of the request to place a purchase order.

Fields

Example

{"purchase_order": PurchaseOrder}

Price

Defines the price of a simple product or a part of a price range for a complex product. It can include a list of price adjustments.

Fields

Example

{
  "adjustments": [PriceAdjustment],
  "amount": ProductViewMoney
}

PriceAdjustment

Specifies the amount and type of price adjustment.

Fields

Example

{"amount": 987.65, "code": "abc123"}

PriceDetails

Can be used to retrieve the main price details in case of bundle product

Fields

Example

{
  "discount_percentage": 123.45,
  "main_final_price": 123.45,
  "main_price": 123.45
}

PriceRange

Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.

Fields

Example

{
  "maximum_price": ProductPrice,
  "minimum_price": ProductPrice
}

PriceTypeEnum

Defines the price type.

Values

Example

""FIXED""

PriceViewEnum

Defines whether a bundle product's price is displayed as the lowest possible value or as a range.

Values

Example

""PRICE_RANGE""

ProductAlertPriceInput

Input Fields

Example

{"sku": "abc123"}

ProductAlertStockInput

Input Fields

Example

{"sku": "abc123"}

ProductAlertSubscriptionResult

Fields

Example

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

ProductAttribute

Contains a product attribute code and value.

Fields

Example

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

ProductAttributeFile

Fields

Example

{
  "attribute_type": "abc123",
  "code": 4,
  "url": "abc123",
  "value": "abc123"
}

ProductCustomAttributes

Product custom attributes

Fields

Example

{
  "errors": [AttributeMetadataError],
  "items": [AttributeValueInterface]
}

ProductDiscount

Contains the discount applied to a product price.

Fields

Example

{"amount_off": 123.45, "percent_off": 123.45}

ProductImage

Contains product image information, including the image URL and label.

Fields

Example

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

ProductImageThumbnail

Values

Example

""ITSELF""

ProductInfoInput

Product Information used for Pickup Locations search.

Input Fields

Example

{"sku": "abc123"}

ProductInterface

Contains fields that are common to all types of products.

Fields

Possible Types

Example

{
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "country_of_manufacture": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "min_sale_qty": 987.65,
  "name": "abc123",
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "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": 123.45,
  "special_to_date": "xyz789",
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "uid": 4,
  "upsell_products": [ProductInterface],
  "url_key": "abc123"
}

ProductLinks

An implementation of ProductLinksInterface.

Fields

Example

{
  "link_type": "abc123",
  "linked_product_sku": "xyz789",
  "linked_product_type": "xyz789",
  "position": 123,
  "sku": "xyz789"
}

ProductLinksInterface

Contains information about linked products, including the link type and product type of each item.

Fields

Possible Types

Example

{
  "link_type": "xyz789",
  "linked_product_sku": "xyz789",
  "linked_product_type": "abc123",
  "position": 123,
  "sku": "xyz789"
}

ProductMediaGalleryEntriesAssetImage

Contains basic information about the image asset.

Fields

Example

{
  "asset_id": "xyz789",
  "media_type": "xyz789",
  "media_url": "xyz789"
}

ProductMediaGalleryEntriesAssetVideo

Contains basic information about the video asset.

Fields

Example

{
  "media_type": "xyz789",
  "video_asset_id": "xyz789",
  "video_media_url": "xyz789"
}

ProductMediaGalleryEntriesVideoContent

Contains a link to a video file and basic information about the video.

Fields

Example

{
  "media_type": "xyz789",
  "video_description": "xyz789",
  "video_metadata": "xyz789",
  "video_provider": "xyz789",
  "video_title": "abc123",
  "video_url": "abc123"
}

ProductPrice

Represents a product price.

Fields

Example

{
  "discount": ProductDiscount,
  "final_price": Money,
  "fixed_product_taxes": [FixedProductTax],
  "regular_price": Money
}

ProductSearchItem

A single product returned by the query

Fields

Example

{
  "applied_query_rule": AppliedQueryRule,
  "highlights": [Highlight],
  "productView": ProductView
}

ProductSearchResponse

Contains the output of a productSearch query

Fields

Example

{
  "facets": [Aggregation],
  "items": [ProductSearchItem],
  "page_info": SearchResultPageInfo,
  "related_terms": ["abc123"],
  "suggestions": ["abc123"],
  "total_count": 123,
  "warnings": [ProductSearchWarning]
}

ProductSearchSortInput

The product attribute to sort on

Input Fields

Example

{"attribute": "abc123", "direction": "ASC"}

ProductSearchWarning

Structured warning with code and message for easier client handling

Fields

Example

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

ProductStockStatus

This enumeration states whether a product stock status is in stock or out of stock

Values

Example

""IN_STOCK""

ProductVideo

Contains information about a product video.

Fields

Example

{
  "disabled": true,
  "label": "abc123",
  "position": 123,
  "url": "abc123",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

ProductView

Defines the product fields available to the SimpleProductView and ComplexProductView types.

Fields

Possible Types

Example

{
  "addToCartAllowed": false,
  "inStock": false,
  "lowStock": true,
  "attributes": [ProductViewAttribute],
  "description": "abc123",
  "id": "4",
  "images": [ProductViewImage],
  "videos": [ProductViewVideo],
  "lastModifiedAt": "2007-12-03T10:15:30Z",
  "metaDescription": "xyz789",
  "metaKeyword": "abc123",
  "metaTitle": "abc123",
  "name": "xyz789",
  "shortDescription": "abc123",
  "inputOptions": [ProductViewInputOption],
  "sku": "abc123",
  "externalId": "xyz789",
  "url": "xyz789",
  "urlKey": "xyz789",
  "links": [ProductViewLink],
  "categories": [CategoryProductView],
  "queryType": "xyz789",
  "visibility": "abc123"
}

ProductViewAttribute

A container for customer-defined attributes that are displayed the storefront.

Fields

Example

{
  "label": "abc123",
  "name": "abc123",
  "roles": ["abc123"],
  "value": {}
}

ProductViewCurrency

The list of supported currency codes.

Values

Example

""AED""

ProductViewImage

Contains details about a product image.

Fields

Example

{
  "label": "abc123",
  "roles": ["abc123"],
  "url": "xyz789"
}

ProductViewInputOption

Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.

Fields

Example

{
  "id": 4,
  "title": "abc123",
  "required": false,
  "type": "abc123",
  "markupAmount": 987.65,
  "suffix": "xyz789",
  "sortOrder": 987,
  "range": ProductViewInputOptionRange,
  "imageSize": ProductViewInputOptionImageSize,
  "fileExtensions": "abc123"
}

ProductViewInputOptionImageSize

Dimensions of the image associated with the input option.

Fields

Example

{"width": 123, "height": 123}

ProductViewInputOptionRange

Lists the value range associated with a ProductViewInputOption. For example, if the input option is a text field, the range represents the number of characters.

Fields

Example

{"from": 987.65, "to": 987.65}

ProductViewLink

The product link type. Contains details about product links for related products and cross selling. For example, related, up_sell or cross_sell

Fields

Example

{
  "product": ProductView,
  "linkTypes": ["xyz789"]
}

ProductViewMoney

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

Fields

Example

{"currency": "AED", "value": 987.65}

ProductViewOption

Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.

Fields

Example

{
  "id": "4",
  "multi": true,
  "required": false,
  "title": "xyz789",
  "values": [ProductViewOptionValue]
}

ProductViewOptionValue

Defines the product fields available to the ProductViewOptionValueProduct and ProductViewOptionValueConfiguration types.

Fields

Possible Types

Example

{
  "id": "4",
  "title": "xyz789",
  "inStock": false
}

ProductViewOptionValueConfiguration

An implementation of ProductViewOptionValue for configuration values.

Fields

Example

{
  "id": "4",
  "title": "xyz789",
  "inStock": false
}

ProductViewOptionValueProduct

An implementation of ProductViewOptionValue that adds details about a simple product.

Fields

Example

{
  "id": 4,
  "isDefault": true,
  "product": SimpleProductView,
  "quantity": 123.45,
  "title": "xyz789",
  "inStock": true
}

ProductViewOptionValueSwatch

An implementation of ProductViewOptionValueSwatch for swatches.

Fields

Example

{
  "id": "4",
  "title": "xyz789",
  "type": "TEXT",
  "value": "abc123",
  "inStock": true
}

ProductViewPrice

Base product price view. Contains the final price after discounts, the regular price, and the list of tier prices.

Fields

Example

{
  "final": Price,
  "regular": Price,
  "tiers": [ProductViewTierPrice],
  "roles": ["xyz789"]
}

ProductViewPriceRange

The minimum and maximum price of a complex product.

Fields

Example

{
  "maximum": ProductViewPrice,
  "minimum": ProductViewPrice
}

ProductViewTierCondition

Types

Example

ProductViewTierRangeCondition

ProductViewTierExactMatchCondition

Minimum quantity (inclusive) required to activate this tier price. For example, a value of 10 means this tier applies when 10 or more items are purchased.

Fields

Example

{"in": [987.65]}

ProductViewTierPrice

The discounted price that applies when the quantity conditions in quantity are satisfied. Contains the monetary amount and any price adjustments applied to this tier.

Fields

Example

{
  "tier": Price,
  "quantity": [ProductViewTierRangeCondition]
}

ProductViewTierRangeCondition

Minimum quantity (inclusive) required to activate this tier price. For example, a value of 10 means this tier applies when 10 or more items are purchased. Maximum quantity (exclusive) required to activate this tier price. For example, a value of 20 means this tier applies when less than 20 items are purchased.

Fields

Example

{"gte": 123.45, "lt": 987.65}

ProductViewVariant

Represents a product variant.

Fields

Example

{
  "selections": ["xyz789"],
  "product": ProductView
}

ProductViewVariantResults

Represents the results of a product variant search.

Fields

Example

{
  "variants": [ProductViewVariant],
  "cursor": "abc123"
}

ProductViewVideo

Contains details about a product video. For example, a video of the product being used or a video of the product being assembled.

Fields

Example

{
  "preview": ProductViewImage,
  "url": "xyz789",
  "description": "xyz789",
  "title": "abc123"
}

PurchaseHistory

User purchase history

Input Fields

Example

{
  "date": "2007-12-03T10:15:30Z",
  "items": ["xyz789"]
}

PurchaseOrder

Contains details about a purchase order.

Fields

Example

{
  "approval_flow": [PurchaseOrderRuleApprovalFlow],
  "available_actions": ["REJECT"],
  "comments": [PurchaseOrderComment],
  "created_at": "abc123",
  "created_by": Customer,
  "history_log": [PurchaseOrderHistoryItem],
  "number": "xyz789",
  "order": CustomerOrder,
  "quote": Cart,
  "status": "PENDING",
  "uid": "4",
  "updated_at": "xyz789"
}

PurchaseOrderAction

Values

Example

""REJECT""

PurchaseOrderActionError

Contains details about a failed action.

Fields

Example

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

PurchaseOrderApprovalFlowEvent

Contains details about a single event in the approval flow of the purchase order.

Fields

Example

{
  "message": "xyz789",
  "name": "xyz789",
  "role": "abc123",
  "status": "PENDING",
  "updated_at": "xyz789"
}

PurchaseOrderApprovalFlowItemStatus

Values

Example

""PENDING""

PurchaseOrderApprovalRule

Contains details about a purchase order approval rule.

Fields

Example

{
  "applies_to_roles": [CompanyRole],
  "approver_roles": [CompanyRole],
  "condition": PurchaseOrderApprovalRuleConditionInterface,
  "created_at": "abc123",
  "created_by": "xyz789",
  "description": "xyz789",
  "name": "abc123",
  "status": "ENABLED",
  "uid": "4",
  "updated_at": "xyz789"
}

PurchaseOrderApprovalRuleConditionAmount

Contains approval rule condition details, including the amount to be evaluated.

Fields

Example

{
  "amount": Money,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN"
}

PurchaseOrderApprovalRuleConditionInterface

Purchase order rule condition details.

Fields

Possible Types

Example

{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}

PurchaseOrderApprovalRuleConditionOperator

Values

Example

""MORE_THAN""

PurchaseOrderApprovalRuleConditionQuantity

Contains approval rule condition details, including the quantity to be evaluated.

Fields

Example

{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987}

PurchaseOrderApprovalRuleInput

Defines a new purchase order approval rule.

Input Fields

Example

{
  "applies_to": ["4"],
  "approvers": ["4"],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "abc123",
  "name": "abc123",
  "status": "ENABLED"
}

PurchaseOrderApprovalRuleMetadata

Contains metadata that can be used to render rule edit forms.

Fields

Example

{
  "available_applies_to": [CompanyRole],
  "available_condition_currencies": [AvailableCurrency],
  "available_requires_approval_from": [CompanyRole]
}

PurchaseOrderApprovalRuleStatus

Values

Example

""ENABLED""

PurchaseOrderApprovalRuleType

Values

Example

""GRAND_TOTAL""

PurchaseOrderApprovalRules

Contains the approval rules that the customer can see.

Fields

Example

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

PurchaseOrderComment

Contains details about a comment.

Fields

Example

{
  "author": Customer,
  "created_at": "abc123",
  "text": "xyz789",
  "uid": 4
}

PurchaseOrderErrorType

Values

Example

""NOT_FOUND""

PurchaseOrderHistoryItem

Contains details about a status change.

Fields

Example

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

PurchaseOrderRuleApprovalFlow

Contains details about approval roles applied to the purchase order and status changes.

Fields

Example

{
  "events": [PurchaseOrderApprovalFlowEvent],
  "rule_name": "xyz789"
}

PurchaseOrderStatus

Values

Example

""PENDING""

PurchaseOrders

Contains a list of purchase orders.

Fields

Example

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

PurchaseOrdersActionInput

Defines which purchase orders to act on.

Input Fields

Example

{"purchase_order_uids": ["4"]}

PurchaseOrdersActionOutput

Returns a list of updated purchase orders and any error messages.

Fields

Example

{
  "errors": [PurchaseOrderActionError],
  "purchase_orders": [PurchaseOrder]
}

PurchaseOrdersFilterInput

Defines the criteria to use to filter the list of purchase orders.

Input Fields

Example

{
  "company_purchase_orders": false,
  "created_date": FilterRangeTypeInput,
  "my_approvals": false,
  "require_my_approval": false,
  "status": "PENDING"
}

QueryContextInput

Input Fields

Example

{
  "customerGroup": "abc123",
  "userViewHistory": [ViewHistoryInput]
}

QuoteItemsSortInput

Specifies the field to use for sorting quote items

Input Fields

Example

{"field": "ITEM_ID", "order": "ASC"}

QuoteTemplateExpirationDateInput

Sets quote template expiration date.

Input Fields

Example

{
  "expiration_date": "abc123",
  "template_id": "4"
}

QuoteTemplateLineItemNoteInput

Sets quote item note.

Input Fields

Example

{
  "item_id": "4",
  "item_uid": 4,
  "note": "abc123",
  "templateId": "4"
}

QuoteTemplateNotificationMessage

Contains a notification message for a negotiable quote template.

Fields

Example

{
  "message": "xyz789",
  "type": "xyz789"
}

RangeBucket

For use on numeric product fields

Fields

Example

{
  "count": 987,
  "from": 123.45,
  "title": "xyz789",
  "to": 123.45
}

RangeOperatorInput

Input Fields

Example

{"type": "UNKNOWN_RANGE_TYPE", "value": RangeValueInput}

RangeType

Values

Example

""UNKNOWN_RANGE_TYPE""

RangeValueInput

Input Fields

Example

{"from": 987.65, "to": 987.65}

ReCaptchaConfigOutput

Fields

Example

{
  "configurations": ReCaptchaConfiguration,
  "is_enabled": false
}

ReCaptchaConfiguration

Contains reCAPTCHA form configuration details.

Fields

Example

{
  "badge_position": "xyz789",
  "language_code": "abc123",
  "minimum_score": 123.45,
  "re_captcha_type": "INVISIBLE",
  "technical_failure_message": "xyz789",
  "theme": "abc123",
  "validation_failure_message": "abc123",
  "website_key": "xyz789"
}

ReCaptchaConfigurationV3

Contains reCAPTCHA V3-Invisible configuration details.

Fields

Example

{
  "badge_position": "abc123",
  "failure_message": "xyz789",
  "forms": ["PLACE_ORDER"],
  "is_enabled": false,
  "language_code": "xyz789",
  "minimum_score": 123.45,
  "theme": "abc123",
  "website_key": "xyz789"
}

ReCaptchaFormConfigItem

Contains reCAPTCHA configuration for a specific form type.

Fields

Example

{
  "configurations": ReCaptchaConfiguration,
  "form_type": "PLACE_ORDER",
  "is_enabled": false
}

ReCaptchaFormEnum

Values

Example

""PLACE_ORDER""

ReCaptchaTypeEmum

Values

Example

""INVISIBLE""

RecommendationUnit

Recommendation Unit containing product and other details

Fields

Example

{
  "displayOrder": 987,
  "pageType": "xyz789",
  "productsView": [ProductView],
  "storefrontLabel": "abc123",
  "totalProducts": 987,
  "typeId": "abc123",
  "unitId": "xyz789",
  "unitName": "xyz789"
}

Recommendations

Recommendations response

Fields

Example

{"results": [RecommendationUnit], "totalResults": 123}

Region

Fields

Example

{
  "code": "xyz789",
  "id": 123,
  "name": "xyz789"
}

RemoveCouponFromCartInput

Specifies the cart from which to remove a coupon.

Input Fields

Example

{"cart_id": "xyz789"}

RemoveCouponFromCartOutput

Contains details about the cart after removing a coupon.

Fields

Example

{"cart": Cart}

RemoveCouponsFromCartInput

Remove coupons from the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "coupon_codes": ["abc123"]
}

RemoveGiftCardFromCartInput

Defines the input required to run the removeGiftCardFromCart mutation.

Input Fields

Example

{
  "cart_id": "xyz789",
  "gift_card_code": "abc123"
}

RemoveGiftCardFromCartOutput

Defines the possible output for the removeGiftCardFromCart mutation.

Fields

Example

{"cart": Cart}

RemoveGiftRegistryItemsOutput

Contains the results of a request to remove an item from a gift registry.

Fields

Example

{"gift_registry": GiftRegistry}

RemoveGiftRegistryOutput

Contains the results of a request to delete a gift registry.

Fields

Example

{"success": true}

RemoveGiftRegistryRegistrantsOutput

Contains the results of a request to delete a registrant.

Fields

Example

{"gift_registry": GiftRegistry}

RemoveItemFromCartInput

Specifies which items to remove from the cart.

Input Fields

Example

{"cart_id": "abc123", "cart_item_uid": 4}

RemoveItemFromCartOutput

Contains details about the cart after removing an item.

Fields

Example

{"cart": Cart}

RemoveNegotiableQuoteItemsInput

Defines the items to remove from the specified negotiable quote.

Input Fields

Example

{"quote_item_uids": [4], "quote_uid": 4}

RemoveNegotiableQuoteItemsOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

RemoveNegotiableQuoteTemplateItemsInput

Defines the items to remove from the specified negotiable quote.

Input Fields

Example

{"item_uids": [4], "template_id": 4}

RemoveProductsFromCompareListInput

Defines which products to remove from a compare list.

Input Fields

Example

{"products": [4], "uid": "4"}

RemoveProductsFromWishlistOutput

Contains the customer's wish list and any errors encountered.

Fields

Example

{
  "user_errors": [WishListUserInputError],
  "wishlist": Wishlist
}

RemoveReturnTrackingInput

Defines the tracking information to delete.

Input Fields

Example

{"return_shipping_tracking_uid": "4"}

RemoveReturnTrackingOutput

Contains the response after deleting tracking information.

Fields

Example

{"return": Return}

RemoveRewardPointsFromCartOutput

Contains the customer cart.

Fields

Example

{"cart": Cart}

RemoveStoreCreditFromCartInput

Defines the input required to run the removeStoreCreditFromCart mutation.

Input Fields

Example

{"cart_id": "xyz789"}

RemoveStoreCreditFromCartOutput

Defines the possible output for the removeStoreCreditFromCart mutation.

Fields

Example

{"cart": Cart}

RenameNegotiableQuoteInput

Sets new name for a negotiable quote.

Input Fields

Example

{
  "quote_comment": "abc123",
  "quote_name": "abc123",
  "quote_uid": "4"
}

RenameNegotiableQuoteOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

ReorderItemsOutput

Contains the cart and any errors after adding products.

Fields

Example

{
  "cart": Cart,
  "userInputErrors": [CheckoutUserInputError]
}

RequestGuestReturnInput

Contains information needed to start a return request.

Input Fields

Example

{
  "comment_text": "xyz789",
  "contact_email": "xyz789",
  "items": [RequestReturnItemInput],
  "token": "abc123"
}

RequestNegotiableQuoteInput

Defines properties of a negotiable quote request.

Input Fields

Example

{
  "cart_id": "4",
  "comment": NegotiableQuoteCommentInput,
  "is_draft": false,
  "quote_name": "xyz789"
}

RequestNegotiableQuoteOutput

Contains the NegotiableQuote object generated when a buyer requests a negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

RequestNegotiableQuoteTemplateInput

Defines properties of a negotiable quote template request.

Input Fields

Example

{"cart_id": 4}

RequestReturnInput

Contains information needed to start a return request.

Input Fields

Example

{
  "comment_text": "xyz789",
  "contact_email": "abc123",
  "items": [RequestReturnItemInput],
  "order_uid": "4"
}

RequestReturnItemInput

Contains details about an item to be returned.

Input Fields

Example

{
  "entered_custom_attributes": [
    EnteredCustomAttributeInput
  ],
  "order_item_uid": "4",
  "quantity_to_return": 987.65,
  "selected_custom_attributes": [
    SelectedCustomAttributeInput
  ]
}

RequestReturnOutput

Contains the response to a return request.

Fields

Example

{
  "return": Return,
  "returns": Returns
}

RequisitionList

Defines the contents of a requisition list.

Fields

Example

{
  "description": "xyz789",
  "items": RequistionListItems,
  "items_count": 123,
  "name": "abc123",
  "uid": "4",
  "updated_at": "abc123"
}

RequisitionListFilterInput

Defines requisition list filters.

Input Fields

Example

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

RequisitionListItemInterface

The interface for requisition list items.

Fields

Possible Types

Example

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

RequisitionListItemsInput

Defines the items to add.

Input Fields

Example

{
  "entered_options": [EnteredOptionInput],
  "parent_sku": "xyz789",
  "quantity": 123.45,
  "selected_options": ["abc123"],
  "sku": "xyz789"
}

RequisitionListSortInput

Defines the field to use to sort a list of requisition lists.

Input Fields

Example

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

RequisitionListSortableField

Values

Example

""NAME""

RequisitionLists

Defines customer requisition lists.

Fields

Example

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

RequistionListItems

Contains an array of items added to a requisition list.

Fields

Example

{
  "items": [RequisitionListItemInterface],
  "page_info": SearchResultPageInfo,
  "total_pages": 123
}

Return

Contains details about a return.

Fields

Example

{
  "available_shipping_carriers": [ReturnShippingCarrier],
  "comments": [ReturnComment],
  "created_at": "abc123",
  "customer": ReturnCustomer,
  "items": [ReturnItem],
  "number": "abc123",
  "order": CustomerOrder,
  "shipping": ReturnShipping,
  "status": "PENDING",
  "uid": "4"
}

ReturnComment

Contains details about a return comment.

Fields

Example

{
  "author_name": "xyz789",
  "created_at": "xyz789",
  "text": "abc123",
  "uid": "4"
}

ReturnCustomer

The customer information for the return.

Fields

Example

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

ReturnItem

Contains details about a product being returned.

Fields

Example

{
  "custom_attributesV2": [AttributeValueInterface],
  "order_item": OrderItemInterface,
  "quantity": 987.65,
  "request_quantity": 987.65,
  "status": "PENDING",
  "uid": "4"
}

ReturnItemAttributeMetadata

Return Item attribute metadata.

Fields

Example

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

ReturnItemStatus

Values

Example

""PENDING""

ReturnShipping

Contains details about the return shipping address.

Fields

Example

{
  "address": ReturnShippingAddress,
  "tracking": [ReturnShippingTracking]
}

ReturnShippingAddress

Contains details about the shipping address used for receiving returned items.

Fields

Example

{
  "city": "xyz789",
  "contact_name": "abc123",
  "country": Country,
  "postcode": "xyz789",
  "region": Region,
  "street": ["abc123"],
  "telephone": "xyz789"
}

ReturnShippingCarrier

Contains details about the carrier on a return.

Fields

Example

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

ReturnShippingTracking

Contains shipping and tracking details.

Fields

Example

{
  "carrier": ReturnShippingCarrier,
  "status": ReturnShippingTrackingStatus,
  "tracking_number": "abc123",
  "uid": "4"
}

ReturnShippingTrackingStatus

Contains the status of a shipment.

Fields

Example

{"text": "abc123", "type": "INFORMATION"}

ReturnShippingTrackingStatusType

Values

Example

""INFORMATION""

ReturnStatus

Values

Example

""PENDING""

Returns

Contains a list of customer return requests.

Fields

Example

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

RevokeCustomerTokenOutput

Contains the result of a request to revoke a customer token.

Fields

Example

{"result": true}

RewardPoints

Contains details about a customer's reward points.

Fields

Example

{
  "balance": RewardPointsAmount,
  "balance_history": [RewardPointsBalanceHistoryItem],
  "exchange_rates": RewardPointsExchangeRates,
  "subscription_status": RewardPointsSubscriptionStatus
}

RewardPointsAmount

Fields

Example

{"money": Money, "points": 123.45}

RewardPointsBalanceHistoryItem

Contain details about the reward points transaction.

Fields

Example

{
  "balance": RewardPointsAmount,
  "change_reason": "xyz789",
  "date": "xyz789",
  "points_change": 987.65
}

RewardPointsExchangeRates

Lists the reward points exchange rates. The values depend on the customer group.

Fields

Example

{
  "earning": RewardPointsRate,
  "redemption": RewardPointsRate
}

RewardPointsRate

Contains details about customer's reward points rate.

Fields

Example

{"currency_amount": 123.45, "points": 987.65}

RewardPointsSubscriptionStatus

Indicates whether the customer subscribes to reward points emails.

Fields

Example

{
  "balance_updates": "SUBSCRIBED",
  "points_expiration_notifications": "SUBSCRIBED"
}

RewardPointsSubscriptionStatusesEnum

Values

Example

""SUBSCRIBED""

SDKParams

Defines the name and value of a SDK parameter

Fields

Example

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

SalesCommentItem

Contains details about a comment.

Fields

Example

{
  "message": "xyz789",
  "timestamp": "xyz789"
}

ScalarBucket

For use on string and other scalar product fields

Fields

Example

{
  "count": 123,
  "id": "4",
  "title": "abc123"
}

ScopeTypeEnum

This enumeration defines the scope type for customer orders.

Values

Example

""GLOBAL""

SearchCategoryResultPage

Represents a paginated result set of category search results.

Fields

Example

{
  "items": [CategoryTreeView],
  "totalCount": 987,
  "pageInfo": PageInfo
}

SearchClauseInput

A product attribute to filter on

Input Fields

Example

{
  "attribute": "xyz789",
  "contains": "xyz789",
  "eq": "abc123",
  "in": ["xyz789"],
  "range": SearchRangeInput,
  "startsWith": "abc123"
}

SearchRangeInput

A range of numeric values for use in a search

Input Fields

Example

{"from": 123.45, "to": 123.45}

SearchResultPageInfo

Provides navigation for the query response.

Fields

Example

{"current_page": 123, "page_size": 987, "total_pages": 987}

SelectedBundleOption

Contains details about a selected bundle option.

Fields

Example

{
  "label": "xyz789",
  "type": "xyz789",
  "uid": 4,
  "values": [SelectedBundleOptionValue]
}

SelectedBundleOptionValue

Contains details about a value for a selected bundle option.

Fields

Example

{
  "label": "xyz789",
  "original_price": Money,
  "priceV2": Money,
  "quantity": 123.45,
  "uid": 4
}

SelectedConfigurableOption

Contains details about a selected configurable option.

Fields

Example

{
  "configurable_product_option_uid": "4",
  "configurable_product_option_value_uid": 4,
  "option_label": "abc123",
  "value_label": "abc123"
}

SelectedCustomAttributeInput

Contains details about an attribute the buyer selected.

Input Fields

Example

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

SelectedCustomizableOption

Identifies a customized product that has been placed in a cart.

Fields

Example

{
  "customizable_option_uid": "4",
  "is_required": true,
  "label": "xyz789",
  "sort_order": 987,
  "type": "abc123",
  "values": [SelectedCustomizableOptionValue]
}

SelectedCustomizableOptionValue

Identifies the value of the selected customized option.

Fields

Example

{
  "customizable_option_value_uid": 4,
  "label": "abc123",
  "price": CartItemSelectedOptionValuePrice,
  "value": "abc123"
}

SelectedPaymentMethod

Describes the payment method selected by the shopper.

Fields

Example

{
  "code": "xyz789",
  "oope_payment_method_config": OopePaymentMethodConfig,
  "purchase_order_number": "xyz789",
  "title": "xyz789"
}

SelectedShippingMethod

Contains details about the selected shipping method and carrier.

Fields

Example

{
  "additional_data": [ShippingAdditionalData],
  "amount": Money,
  "carrier_code": "xyz789",
  "carrier_title": "xyz789",
  "method_code": "xyz789",
  "method_title": "abc123",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

SendNegotiableQuoteForReviewInput

Specifies which negotiable quote to send for review.

Input Fields

Example

{
  "comment": NegotiableQuoteCommentInput,
  "quote_uid": "4"
}

SendNegotiableQuoteForReviewOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetBillingAddressOnCartInput

Sets the billing address.

Input Fields

Example

{
  "billing_address": BillingAddressInput,
  "cart_id": "xyz789"
}

SetBillingAddressOnCartOutput

Contains details about the cart after setting the billing address.

Fields

Example

{"cart": Cart}

SetCartAsInactiveOutput

Sets the cart as inactive

Fields

Example

{"error": "abc123", "success": true}

SetCustomAttributesOnCompanyInput

Defines the company custom attributes.

Input Fields

Example

{
  "custom_attributes": [CustomAttributeInput],
  "id": "4"
}

SetCustomAttributesOnCompanyOutput

Contains the company.

Fields

Example

{"company": Company}

SetCustomAttributesOnNegotiableQuoteInput

Defines the negotiable quote custom attributes.

Input Fields

Example

{
  "custom_attributes": [CustomAttributeInput],
  "quote_uid": "4"
}

SetCustomAttributesOnNegotiableQuoteOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetGiftOptionsOnCartInput

Defines the gift options applied to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "gift_message": GiftMessageInput,
  "gift_receipt_included": true,
  "gift_wrapping_id": 4,
  "printed_card_included": true
}

SetGiftOptionsOnCartOutput

Contains the cart after gift options have been applied.

Fields

Example

{"cart": Cart}

SetGuestEmailOnCartInput

Defines the guest email and cart.

Input Fields

Example

{
  "cart_id": "abc123",
  "email": "abc123"
}

SetGuestEmailOnCartOutput

Contains details about the cart after setting the email of a guest.

Fields

Example

{"cart": Cart}

SetLineItemNoteOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteBillingAddressInput

Sets the billing address.

Input Fields

Example

{
  "billing_address": NegotiableQuoteBillingAddressInput,
  "quote_uid": "4"
}

SetNegotiableQuoteBillingAddressOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuotePaymentMethodInput

Defines the payment method of the specified negotiable quote.

Input Fields

Example

{
  "payment_method": NegotiableQuotePaymentMethodInput,
  "quote_uid": "4"
}

SetNegotiableQuotePaymentMethodOutput

Contains details about the negotiable quote after setting the payment method.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteShippingAddressInput

Defines the shipping address to assign to the negotiable quote.

Input Fields

Example

{
  "quote_uid": 4,
  "shipping_addresses": [
    NegotiableQuoteShippingAddressInput
  ]
}

SetNegotiableQuoteShippingAddressOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteShippingMethodsInput

Defines the shipping method to apply to the negotiable quote.

Input Fields

Example

{
  "quote_uid": 4,
  "shipping_methods": [ShippingMethodInput]
}

SetNegotiableQuoteShippingMethodsOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteTemplateShippingAddressInput

Defines the shipping address to assign to the negotiable quote template.

Input Fields

Example

{
  "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
  "template_id": 4
}

SetPaymentMethodOnCartInput

Applies a payment method to the cart.

Input Fields

Example

{
  "cart_id": "abc123",
  "payment_method": PaymentMethodInput
}

SetPaymentMethodOnCartOutput

Contains details about the cart after setting the payment method.

Fields

Example

{"cart": Cart}

SetShippingAddressesOnCartInput

Specifies an array of addresses to use for shipping.

Input Fields

Example

{
  "cart_id": "xyz789",
  "shipping_addresses": [ShippingAddressInput]
}

SetShippingAddressesOnCartOutput

Contains details about the cart after setting the shipping addresses.

Fields

Example

{"cart": Cart}

SetShippingMethodsOnCartInput

Applies one or shipping methods to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "shipping_methods": [ShippingMethodInput]
}

SetShippingMethodsOnCartOutput

Contains details about the cart after setting the shipping methods.

Fields

Example

{"cart": Cart}

ShareGiftRegistryInviteeInput

Defines a gift registry invitee.

Input Fields

Example

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

ShareGiftRegistryOutput

Contains the results of a request to share a gift registry.

Fields

Example

{"is_shared": false}

ShareGiftRegistrySenderInput

Defines the sender of an invitation to view a gift registry.

Input Fields

Example

{
  "message": "abc123",
  "name": "abc123"
}

ShipBundleItemsEnum

Defines whether bundle items must be shipped together.

Values

Example

""TOGETHER""

ShipmentItem

Fields

Example

{
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 987.65
}

ShipmentItemInterface

Order shipment item details.

Fields

Possible Types

Example

{
  "id": "4",
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "abc123",
  "quantity_shipped": 987.65
}

ShipmentTracking

Contains order shipment tracking details.

Fields

Example

{
  "carrier": "xyz789",
  "number": "xyz789",
  "title": "abc123"
}

ShippingAdditionalData

A simple key value object.

Fields

Example

{
  "key": "xyz789",
  "value": "xyz789"
}

ShippingAddressInput

Defines a single shipping address.

Input Fields

Example

{
  "address": CartAddressInput,
  "customer_address_id": 123,
  "customer_address_uid": 4,
  "customer_notes": "xyz789",
  "pickup_location_code": "abc123"
}

ShippingCartAddress

Contains shipping addresses and methods.

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "cart_items_v2": [CartItemInterface],
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "customer_notes": "xyz789",
  "fax": "abc123",
  "firstname": "xyz789",
  "id": 987,
  "lastname": "xyz789",
  "middlename": "xyz789",
  "pickup_location_code": "abc123",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CartAddressRegion,
  "same_as_billing": false,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "uid": "4",
  "vat_id": "abc123"
}

ShippingDiscount

Defines an individual shipping discount. This discount can be applied to shipping.

Fields

Example

{"amount": Money}

ShippingHandling

Contains details about shipping and handling costs.

Fields

Example

{
  "amount_excluding_tax": Money,
  "amount_including_tax": Money,
  "discounts": [ShippingDiscount],
  "taxes": [TaxItem],
  "total_amount": Money
}

ShippingMethodInput

Defines the shipping carrier and method.

Input Fields

Example

{
  "carrier_code": "abc123",
  "method_code": "abc123"
}

SimpleCartItem

An implementation for simple product cart items.

Fields

Example

{
  "available_gift_wrapping": [GiftWrapping],
  "custom_attributes": [CustomAttribute],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "is_available": false,
  "max_qty": 987.65,
  "min_qty": 987.65,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

SimpleProduct

Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities.

Fields

Example

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

SimpleProductView

Represents a single-SKU product without selectable variants. Because there are no variant combinations, pricing is returned as a single price (not a price range).

Fields

Example

{
  "addToCartAllowed": false,
  "inStock": true,
  "lowStock": false,
  "attributes": [ProductViewAttribute],
  "description": "abc123",
  "id": 4,
  "images": [ProductViewImage],
  "videos": [ProductViewVideo],
  "inputOptions": [ProductViewInputOption],
  "lastModifiedAt": "2007-12-03T10:15:30Z",
  "metaDescription": "abc123",
  "metaKeyword": "xyz789",
  "metaTitle": "xyz789",
  "name": "abc123",
  "price": ProductViewPrice,
  "shortDescription": "abc123",
  "sku": "abc123",
  "externalId": "abc123",
  "url": "xyz789",
  "urlKey": "abc123",
  "links": [ProductViewLink],
  "categories": [CategoryProductView],
  "queryType": "xyz789",
  "visibility": "abc123"
}

SimpleRequisitionListItem

Contains details about simple products added to a requisition list.

Fields

Example

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

SimpleWishlistItem

Contains a simple product wish list item.

Fields

Example

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

SmartButtonMethodInput

Smart button payment inputs

Input Fields

Example

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

SmartButtonsConfig

Fields

Example

{
  "app_switch_when_available": true,
  "button_styles": ButtonStyles,
  "code": "abc123",
  "display_message": true,
  "display_venmo": false,
  "is_visible": true,
  "message_styles": MessageStyles,
  "payment_intent": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "title": "xyz789"
}

SortEnum

Indicates whether to return results in ascending or descending order.

Values

Example

""ASC""

SortField

Defines a possible sort field.

Fields

Example

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

SortFields

Contains a default value for sort fields and all available sort fields.

Fields

Example

{
  "default": "abc123",
  "options": [SortField]
}

SortQuoteItemsEnum

Specifies the field to use for sorting quote items

Values

Example

""ITEM_ID""

SortableAttribute

Contains product attributes that be used for sorting in a productSearch query

Fields

Example

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

StatsBucket

For retrieving statistics across multiple buckets

Fields

Example

{
  "max": 987.65,
  "min": 987.65,
  "title": "abc123"
}