Types

AcceptNegotiableQuoteTemplateInput

Specifies the quote template id to accept quote template.

Input Fields

Example

{"template_id": "4"}

AddBundleProductsToCartInput

Defines the bundle products to add to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "cart_items": [BundleProductCartItemInput]
}

AddBundleProductsToCartOutput

Contains details about the cart after adding bundle products.

Fields

Example

{"cart": Cart}

AddConfigurableProductsToCartInput

Defines the configurable products to add to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "cart_items": [ConfigurableProductCartItemInput]
}

AddConfigurableProductsToCartOutput

Contains details about the cart after adding configurable products.

Fields

Example

{"cart": Cart}

AddDownloadableProductsToCartInput

Input Fields

Example

{
  "cart_id": "abc123",
  "cart_items": [DownloadableProductCartItemInput]
}

AddDownloadableProductsToCartOutput

Contains details about the cart after adding downloadable products.

Fields

Example

{"cart": Cart}

AddGiftRegistryRegistrantInput

Defines a new registrant.

Input Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "email": "xyz789",
  "firstname": "xyz789",
  "lastname": "abc123"
}

AddGiftRegistryRegistrantsOutput

Contains the results of a request to add registrants.

Fields

Example

{"gift_registry": GiftRegistry}

AddProductsToCartOutput

Contains details about the cart after adding products to it.

Fields

Example

{
  "cart": Cart,
  "user_errors": [CartUserInputError]
}

AddProductsToCompareListInput

Contains products to add to an existing compare list.

Input Fields

Example

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

AddProductsToRequisitionListOutput

Output of the request to add products to a requisition list.

Fields

Example

{"requisition_list": RequisitionList}

AddProductsToWishlistOutput

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

Fields

Example

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

AddPurchaseOrderCommentInput

Contains the comment to be added to a purchase order.

Input Fields

Example

{
  "comment": "abc123",
  "purchase_order_uid": "4"
}

AddPurchaseOrderCommentOutput

Contains the successfully added comment.

Fields

Example

{"comment": PurchaseOrderComment}

AddPurchaseOrderItemsToCartInput

Defines the purchase order and cart to act on.

Input Fields

Example

{
  "cart_id": "abc123",
  "purchase_order_uid": 4,
  "replace_existing_cart_items": true
}

AddRequisitionListItemToCartUserError

Contains details about why an attempt to add items to the requistion list failed.

Fields

Example

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

AddRequisitionListItemToCartUserErrorType

Values

Example

""OUT_OF_STOCK""

AddRequisitionListItemsToCartOutput

Output of the request to add items in a requisition list to the cart.

Fields

Example

{
  "add_requisition_list_items_to_cart_user_errors": [
    AddRequisitionListItemToCartUserError
  ],
  "cart": Cart,
  "status": false
}

AddReturnCommentInput

Defines a return comment.

Input Fields

Example

{"comment_text": "abc123", "return_uid": 4}

AddReturnCommentOutput

Contains details about the return request.

Fields

Example

{"return": Return}

AddReturnTrackingInput

Defines tracking information to be added to the return.

Input Fields

Example

{
  "carrier_uid": 4,
  "return_uid": "4",
  "tracking_number": "xyz789"
}

AddReturnTrackingOutput

Contains the response after adding tracking information.

Fields

Example

{
  "return": Return,
  "return_shipping_tracking": ReturnShippingTracking
}

AddSimpleProductsToCartInput

Defines the simple and group products to add to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "cart_items": [SimpleProductCartItemInput]
}

AddSimpleProductsToCartOutput

Contains details about the cart after adding simple or group products.

Fields

Example

{"cart": Cart}

AddVirtualProductsToCartInput

Defines the virtual products to add to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "cart_items": [VirtualProductCartItemInput]
}

AddVirtualProductsToCartOutput

Contains details about the cart after adding virtual products.

Fields

Example

{"cart": Cart}

AddWishlistItemsToCartOutput

Contains the resultant wish list and any error information.

Fields

Example

{
  "add_wishlist_items_to_cart_user_errors": [
    WishlistCartUserInputError
  ],
  "status": false,
  "wishlist": Wishlist
}

Aggregation

Contains information for each filterable option (such as price, category UID, and custom attributes).

Fields

Example

{
  "attribute_code": "abc123",
  "count": 987,
  "label": "abc123",
  "options": [AggregationOption],
  "position": 987
}

AggregationOption

An implementation of AggregationOptionInterface.

Fields

Example

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

AggregationOptionInterface

Defines aggregation option fields.

Fields

Possible Types

Example

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

AggregationsCategoryFilterInput

Filter category aggregations in layered navigation.

Input Fields

Example

{"includeDirectChildrenOnly": false}

AggregationsFilterInput

An input object that specifies the filters used in product aggregations.

Input Fields

Example

{"category": AggregationsCategoryFilterInput}

ApplePayConfig

Fields

Example

{
  "button_styles": ButtonStyles,
  "code": "abc123",
  "is_visible": false,
  "payment_intent": "xyz789",
  "payment_source": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "title": "xyz789"
}

ApplePayMethodInput

Apple Pay inputs

Input Fields

Example

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

AppliedCoupon

Contains the applied coupon code.

Fields

Example

{"code": "xyz789"}

AppliedGiftCard

Contains an applied gift card with applied and remaining balance.

Fields

Example

{
  "applied_balance": Money,
  "code": "abc123",
  "current_balance": Money,
  "expiration_date": "abc123"
}

AppliedStoreCredit

Contains the applied and current balances.

Fields

Example

{
  "applied_balance": Money,
  "current_balance": Money,
  "enabled": true
}

ApplyCouponToCartInput

Specifies the coupon code to apply to the cart.

Input Fields

Example

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

ApplyCouponToCartOutput

Contains details about the cart after applying a coupon.

Fields

Example

{"cart": Cart}

ApplyCouponsStrategy

The strategy to apply coupons to the cart.

Values

Example

""APPEND""

ApplyCouponsToCartInput

Apply coupons to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "coupon_codes": ["xyz789"],
  "type": "APPEND"
}

ApplyGiftCardToCartInput

Defines the input required to run the applyGiftCardToCart mutation.

Input Fields

Example

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

ApplyGiftCardToCartOutput

Defines the possible output for the applyGiftCardToCart mutation.

Fields

Example

{"cart": Cart}

ApplyRewardPointsToCartOutput

Contains the customer cart.

Fields

Example

{"cart": Cart}

ApplyStoreCreditToCartInput

Defines the input required to run the applyStoreCreditToCart mutation.

Input Fields

Example

{"cart_id": "abc123"}

ApplyStoreCreditToCartOutput

Defines the possible output for the applyStoreCreditToCart mutation.

Fields

Example

{"cart": Cart}

AreaInput

AreaInput defines the parameters which will be used for filter by specified location.

Input Fields

Example

{"radius": 123, "search_term": "abc123"}

AssignCompareListToCustomerOutput

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

Fields

Example

{"compare_list": CompareList, "result": true}

Attribute

Contains details about the attribute, including the code and type.

Fields

Example

{
  "attribute_code": "abc123",
  "attribute_options": [AttributeOption],
  "attribute_type": "xyz789",
  "entity_type": "xyz789",
  "input_type": "xyz789",
  "storefront_properties": StorefrontProperties
}

AttributeEntityTypeEnum

List of all entity types. Populated by the modules introducing EAV entities.

Values

Example

""CATALOG_PRODUCT""

AttributeFilterInput

An input object that specifies the filters used for attributes.

Input Fields

Example

{
  "is_comparable": true,
  "is_filterable": false,
  "is_filterable_in_search": true,
  "is_html_allowed_on_front": true,
  "is_searchable": true,
  "is_used_for_customer_segment": false,
  "is_used_for_price_rules": true,
  "is_used_for_promo_rules": true,
  "is_visible_in_advanced_search": true,
  "is_visible_on_front": true,
  "is_wysiwyg_enabled": false,
  "used_in_product_listing": true
}

AttributeFrontendInputEnum

EAV attribute frontend input types.

Values

Example

""BOOLEAN""

AttributeInput

Defines the attribute characteristics to search for the attribute_code and entity_type to search.

Input Fields

Example

{
  "attribute_code": "xyz789",
  "entity_type": "xyz789"
}

AttributeInputSelectedOption

Specifies selected option for a select or multiselect attribute value.

Input Fields

Example

{"value": "xyz789"}

AttributeMetadata

Base EAV implementation of CustomAttributeMetadataInterface.

Fields

Example

{
  "code": "4",
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "is_required": true,
  "is_unique": false,
  "label": "xyz789",
  "options": [CustomAttributeOptionInterface]
}

AttributeMetadataError

Attribute metadata retrieval error.

Fields

Example

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

AttributeMetadataErrorType

Attribute metadata retrieval error types.

Values

Example

""ENTITY_NOT_FOUND""

AttributeOption

Defines an attribute option.

Fields

Example

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

AttributeOptionMetadata

Base EAV implementation of CustomAttributeOptionInterface.

Fields

Example

{
  "is_default": false,
  "label": "xyz789",
  "value": "xyz789"
}

AttributeSelectedOption

Fields

Example

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

AttributeSelectedOptionInterface

Fields

Possible Types

Example

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

AttributeSelectedOptions

Fields

Example

{
  "code": "4",
  "selected_options": [AttributeSelectedOptionInterface]
}

AttributeValue

Fields

Example

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

AttributeValueInput

Specifies the value for attribute.

Input Fields

Example

{
  "attribute_code": "xyz789",
  "selected_options": [AttributeInputSelectedOption],
  "value": "abc123"
}

AttributeValueInterface

Fields

Possible Types

Example

{"code": 4}

AttributesFormOutput

Metadata of EAV attributes associated to form

Fields

Example

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

AttributesMetadataOutput

Metadata of EAV attributes.

Fields

Example

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

AvailableCurrency

Defines the code and symbol of a currency that can be used for purchase orders.

Fields

Example

{"code": "AFN", "symbol": "xyz789"}

AvailablePaymentMethod

Describes a payment method that the shopper can use to pay for the order.

Fields

Example

{
  "code": "xyz789",
  "is_deferred": true,
  "title": "xyz789"
}

AvailableShippingMethod

Contains details about the possible shipping methods and carriers.

Fields

Example

{
  "amount": Money,
  "available": true,
  "base_amount": Money,
  "carrier_code": "xyz789",
  "carrier_title": "abc123",
  "error_message": "abc123",
  "method_code": "xyz789",
  "method_title": "abc123",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

BatchMutationStatus

Values

Example

""SUCCESS""

BillingAddressInput

Defines the billing address.

Input Fields

Example

{
  "address": CartAddressInput,
  "customer_address_id": 123,
  "same_as_shipping": true,
  "use_for_shipping": true
}

BillingCartAddress

Contains details about the billing address.

Fields

Example

{
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_notes": "xyz789",
  "fax": "abc123",
  "firstname": "xyz789",
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": CartAddressRegion,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "abc123",
  "uid": "abc123",
  "vat_id": "abc123"
}

Boolean

The Boolean scalar type represents true or false.

Example

true

BraintreeCcVaultInput

Input Fields

Example

{
  "device_data": "xyz789",
  "public_hash": "xyz789"
}

BraintreeInput

Input Fields

Example

{
  "device_data": "abc123",
  "is_active_payment_token_enabler": false,
  "payment_method_nonce": "abc123"
}

BraintreeVaultInput

Input Fields

Example

{
  "device_data": "xyz789",
  "public_hash": "xyz789"
}

Breadcrumb

Contains details about an individual category that comprises a breadcrumb.

Fields

Example

{
  "category_id": 987,
  "category_level": 123,
  "category_name": "abc123",
  "category_uid": "4",
  "category_url_key": "abc123",
  "category_url_path": "abc123"
}

BundleCartItem

An implementation for bundle product cart items.

Fields

Example

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

BundleCreditMemoItem

Defines bundle product options for CreditMemoItemInterface.

Fields

Example

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

BundleInvoiceItem

Defines bundle product options for InvoiceItemInterface.

Fields

Example

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

BundleItem

Defines an individual item within a bundle product.

Fields

Example

{
  "option_id": 123,
  "options": [BundleItemOption],
  "position": 987,
  "price_range": PriceRange,
  "required": false,
  "sku": "abc123",
  "title": "xyz789",
  "type": "xyz789",
  "uid": "4"
}

BundleItemOption

Defines the characteristics that comprise a specific bundle item and its options.

Fields

Example

{
  "can_change_quantity": false,
  "id": 987,
  "is_default": false,
  "label": "xyz789",
  "position": 123,
  "price": 123.45,
  "price_type": "FIXED",
  "product": ProductInterface,
  "qty": 987.65,
  "quantity": 987.65,
  "uid": "4"
}

BundleOptionInput

Defines the input for a bundle option.

Input Fields

Example

{
  "id": 987,
  "quantity": 123.45,
  "value": ["xyz789"]
}

BundleOrderItem

Defines bundle product options for OrderItemInterface.

Fields

Example

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

BundleProduct

Defines basic features of a bundle product and contains multiple BundleItems.

Fields

Example

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

BundleProductCartItemInput

Defines a single bundle product.

Input Fields

Example

{
  "bundle_options": [BundleOptionInput],
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput
}

BundleRequisitionListItem

Contains details about bundle products added to a requisition list.

Fields

Example

{
  "bundle_options": [SelectedBundleOption],
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

BundleShipmentItem

Defines bundle product options for ShipmentItemInterface.

Fields

Example

{
  "bundle_options": [ItemSelectedBundleOption],
  "id": 4,
  "order_item": OrderItemInterface,
  "product_name": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 987.65
}

BundleWishlistItem

Defines bundle product options for WishlistItemInterface.

Fields

Example

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

ButtonStyles

Fields

Example

{
  "color": "abc123",
  "height": 987,
  "label": "abc123",
  "layout": "xyz789",
  "shape": "abc123",
  "tagline": false,
  "use_default_height": false
}