Types

QuoteItemsSortInput

Specifies the field to use for sorting quote items

Input Fields

Example

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

QuoteTemplateLineItemNoteInput

Sets quote item note.

Input Fields

Example

{
  "item_id": 4,
  "note": "xyz789",
  "templateId": 4
}

QuoteTemplateNotificationMessage

Contains a notification message for a negotiable quote template.

Fields

Example

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

ReCaptchaConfigOutput

Fields

Example

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

ReCaptchaConfiguration

Contains reCAPTCHA form configuration details.

Fields

Example

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

ReCaptchaConfigurationV3

Contains reCAPTCHA V3-Invisible configuration details.

Fields

Example

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

ReCaptchaFormEnum

Values

Example

""PLACE_ORDER""

ReCaptchaTypeEmum

Values

Example

""INVISIBLE""

Region

Fields

Example

{
  "code": "abc123",
  "id": 987,
  "name": "abc123"
}

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

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

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_id": 987,
  "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": "xyz789",
  "quote_name": "xyz789",
  "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": "abc123",
  "contact_email": "abc123",
  "items": [RequestReturnItemInput],
  "token": "xyz789"
}

RequestNegotiableQuoteInput

Defines properties of a negotiable quote request.

Input Fields

Example

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

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

RequisitionListItems

Contains an array of items added to a requisition list.

Fields

Example

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

RequisitionListItemsInput

Defines the items to add.

Input Fields

Example

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

RequisitionLists

Defines customer requisition lists.

Fields

Example

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

RequistionListItems

Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release.

Fields

Example

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

Return

Contains details about a return.

Fields

Example

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

ReturnComment

Contains details about a return comment.

Fields

Example

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

ReturnCustomAttribute

Contains details about a ReturnCustomerAttribute object.

Fields

Example

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

ReturnCustomer

The customer information for the return.

Fields

Example

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

ReturnItem

Contains details about a product being returned.

Fields

Example

{
  "custom_attributes": [ReturnCustomAttribute],
  "custom_attributesV2": [AttributeValueInterface],
  "order_item": OrderItemInterface,
  "quantity": 123.45,
  "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": true,
  "label": "abc123",
  "multiline_count": 987,
  "options": [CustomAttributeOptionInterface],
  "sort_order": 987,
  "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": "xyz789",
  "country": Country,
  "postcode": "abc123",
  "region": Region,
  "street": ["abc123"],
  "telephone": "xyz789"
}

ReturnShippingCarrier

Contains details about the carrier on a return.

Fields

Example

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

ReturnShippingTracking

Contains shipping and tracking details.

Fields

Example

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

ReturnShippingTrackingStatus

Contains the status of a shipment.

Fields

Example

{"text": "xyz789", "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": 987
}

RevokeCustomerTokenOutput

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

Fields

Example

{"result": false}

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": "abc123",
  "points_change": 123.45
}

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": 987.65, "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""

RoutableInterface

Routable entities serve as the model for a rendered page.

Fields

Possible Types

Example

{
  "redirect_code": 123,
  "relative_url": "xyz789",
  "type": "CMS_PAGE"
}

RoutableUrl

Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity.

Fields

Example

{
  "redirect_code": 987,
  "relative_url": "abc123",
  "type": "CMS_PAGE"
}

SDKParams

Defines the name and value of a SDK parameter

Fields

Example

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

SalesCommentItem

Contains details about a comment.

Fields

Example

{
  "message": "abc123",
  "timestamp": "abc123"
}

ScopeTypeEnum

This enumeration defines the scope type for customer orders.

Values

Example

""GLOBAL""

SearchResultPageInfo

Provides navigation for the query response.

Fields

Example

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

SearchSuggestion

A string that contains search suggestion

Fields

Example

{"search": "xyz789"}

SelectedBundleOption

Contains details about a selected bundle option.

Fields

Example

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

SelectedBundleOptionValue

Contains details about a value for a selected bundle option.

Fields

Example

{
  "id": 987,
  "label": "abc123",
  "original_price": Money,
  "price": 123.45,
  "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",
  "id": 987,
  "option_label": "xyz789",
  "value_id": 123,
  "value_label": "xyz789"
}

SelectedCustomAttributeInput

Contains details about an attribute the buyer selected.

Input Fields

Example

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

SelectedCustomizableOption

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

Fields

Example

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

SelectedCustomizableOptionValue

Identifies the value of the selected customized option.

Fields

Example

{
  "customizable_option_value_uid": "4",
  "id": 123,
  "label": "xyz789",
  "price": CartItemSelectedOptionValuePrice,
  "value": "xyz789"
}

SelectedPaymentMethod

Describes the payment method the shopper selected.

Fields

Example

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

SelectedShippingMethod

Contains details about the selected shipping method and carrier.

Fields

Example

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

SendEmailToFriendInput

Defines the referenced product and the email sender and recipients.

Input Fields

Example

{
  "product_id": 123,
  "recipients": [SendEmailToFriendRecipientInput],
  "sender": SendEmailToFriendSenderInput
}

SendEmailToFriendOutput

Contains information about the sender and recipients.

Fields

Example

{
  "recipients": [SendEmailToFriendRecipient],
  "sender": SendEmailToFriendSender
}

SendEmailToFriendRecipient

An output object that contains information about the recipient.

Fields

Example

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

SendEmailToFriendRecipientInput

Contains details about a recipient.

Input Fields

Example

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

SendEmailToFriendSender

An output object that contains information about the sender.

Fields

Example

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

SendEmailToFriendSenderInput

Contains details about the sender.

Input Fields

Example

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

SendFriendConfiguration

Contains details about the configuration of the Email to a Friend feature.

Fields

Example

{"enabled_for_customers": false, "enabled_for_guests": false}

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

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

{
  "customer_address_id": "4",
  "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"
}

SetPaymentMethodAndPlaceOrderInput

Applies a payment method to the quote.

Input Fields

Example

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

SetPaymentMethodOnCartInput

Applies a payment method to the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "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": "abc123",
  "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": "xyz789",
  "name": "abc123"
}

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

ShipBundleItemsEnum

Defines whether bundle items must be shipped together.

Values

Example

""TOGETHER""

ShipmentItem

Fields

Example

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

ShipmentItemInterface

Order shipment item details.

Fields

Possible Types

Example

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

ShipmentTracking

Contains order shipment tracking details.

Fields

Example

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

ShippingAddressInput

Defines a single shipping address.

Input Fields

Example

{
  "address": CartAddressInput,
  "customer_address_id": 987,
  "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": [CartItemQuantity],
  "cart_items_v2": [CartItemInterface],
  "city": "abc123",
  "company": "xyz789",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "customer_notes": "xyz789",
  "fax": "abc123",
  "firstname": "abc123",
  "id": 123,
  "items_weight": 123.45,
  "lastname": "xyz789",
  "middlename": "abc123",
  "pickup_location_code": "abc123",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CartAddressRegion,
  "same_as_billing": false,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "uid": "4",
  "vat_id": "xyz789"
}

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],
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "abc123",
  "is_available": true,
  "max_qty": 123.45,
  "min_qty": 123.45,
  "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

{
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 123,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": true,
  "gift_wrapping_available": false,
  "gift_wrapping_price": Money,
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 987,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "abc123",
  "min_sale_qty": 987.65,
  "name": "xyz789",
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "rating_summary": 987.65,
  "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": "abc123",
  "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": "abc123",
  "uid": 4,
  "updated_at": "abc123",
  "upsell_products": [ProductInterface],
  "url_key": "abc123",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "websites": [Website],
  "weight": 987.65
}

SimpleProductCartItemInput

Defines a single product to add to the cart.

Input Fields

Example

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

SimpleRequisitionListItem

Contains details about simple products added to a requisition list.

Fields

Example

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

SimpleWishlistItem

Contains a simple product wish list item.

Fields

Example

{
  "added_at": "abc123",
  "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": "xyz789"
}

SmartButtonsConfig

Fields

Example

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

SortEnum

Indicates whether to return results in ascending or descending order.

Values

Example

""ASC""

SortField

Defines a possible sort field.

Fields

Example

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

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

StoreConfig

Contains information about a store's configuration.

Fields

Example

{
  "absolute_footer": "xyz789",
  "allow_gift_receipt": "abc123",
  "allow_gift_wrapping_on_order": "xyz789",
  "allow_gift_wrapping_on_order_items": "xyz789",
  "allow_guests_to_write_product_reviews": "xyz789",
  "allow_items": "xyz789",
  "allow_order": "abc123",
  "allow_printed_card": "abc123",
  "autocomplete_on_storefront": true,
  "base_currency_code": "abc123",
  "base_link_url": "xyz789",
  "base_media_url": "abc123",
  "base_static_url": "abc123",
  "base_url": "abc123",
  "braintree_3dsecure_allowspecific": false,
  "braintree_3dsecure_always_request_3ds": true,
  "braintree_3dsecure_specificcountry": "xyz789",
  "braintree_3dsecure_threshold_amount": "abc123",
  "braintree_3dsecure_verify_3dsecure": true,
  "braintree_ach_direct_debit_vault_active": true,
  "braintree_applepay_merchant_name": "abc123",
  "braintree_applepay_vault_active": true,
  "braintree_cc_vault_active": "xyz789",
  "braintree_cc_vault_cvv": false,
  "braintree_environment": "xyz789",
  "braintree_googlepay_btn_color": "xyz789",
  "braintree_googlepay_cctypes": "abc123",
  "braintree_googlepay_merchant_id": "abc123",
  "braintree_googlepay_vault_active": false,
  "braintree_local_payment_allowed_methods": "xyz789",
  "braintree_local_payment_fallback_button_text": "xyz789",
  "braintree_local_payment_redirect_on_fail": "xyz789",
  "braintree_merchant_account_id": "xyz789",
  "braintree_paypal_button_location_cart_type_credit_color": "abc123",
  "braintree_paypal_button_location_cart_type_credit_label": "abc123",
  "braintree_paypal_button_location_cart_type_credit_shape": "xyz789",
  "braintree_paypal_button_location_cart_type_credit_show": true,
  "braintree_paypal_button_location_cart_type_messaging_layout": "abc123",
  "braintree_paypal_button_location_cart_type_messaging_logo": "xyz789",
  "braintree_paypal_button_location_cart_type_messaging_logo_position": "xyz789",
  "braintree_paypal_button_location_cart_type_messaging_show": true,
  "braintree_paypal_button_location_cart_type_messaging_text_color": "abc123",
  "braintree_paypal_button_location_cart_type_paylater_color": "abc123",
  "braintree_paypal_button_location_cart_type_paylater_label": "xyz789",
  "braintree_paypal_button_location_cart_type_paylater_shape": "abc123",
  "braintree_paypal_button_location_cart_type_paylater_show": false,
  "braintree_paypal_button_location_cart_type_paypal_color": "xyz789",
  "braintree_paypal_button_location_cart_type_paypal_label": "xyz789",
  "braintree_paypal_button_location_cart_type_paypal_shape": "abc123",
  "braintree_paypal_button_location_cart_type_paypal_show": false,
  "braintree_paypal_button_location_checkout_type_credit_color": "xyz789",
  "braintree_paypal_button_location_checkout_type_credit_label": "abc123",
  "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
  "braintree_paypal_button_location_checkout_type_credit_show": false,
  "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
  "braintree_paypal_button_location_checkout_type_messaging_logo": "xyz789",
  "braintree_paypal_button_location_checkout_type_messaging_logo_position": "xyz789",
  "braintree_paypal_button_location_checkout_type_messaging_show": false,
  "braintree_paypal_button_location_checkout_type_messaging_text_color": "abc123",
  "braintree_paypal_button_location_checkout_type_paylater_color": "xyz789",
  "braintree_paypal_button_location_checkout_type_paylater_label": "abc123",
  "braintree_paypal_button_location_checkout_type_paylater_shape": "xyz789",
  "braintree_paypal_button_location_checkout_type_paylater_show": false,
  "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
  "braintree_paypal_button_location_checkout_type_paypal_label": "abc123",
  "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123",
  "braintree_paypal_button_location_checkout_type_paypal_show": false,
  "braintree_paypal_button_location_productpage_type_credit_color": "xyz789",
  "braintree_paypal_button_location_productpage_type_credit_label": "abc123",
  "braintree_paypal_button_location_productpage_type_credit_shape": "xyz789",
  "braintree_paypal_button_location_productpage_type_credit_show": true,
  "braintree_paypal_button_location_productpage_type_messaging_layout": "xyz789",
  "braintree_paypal_button_location_productpage_type_messaging_logo": "xyz789",
  "braintree_paypal_button_location_productpage_type_messaging_logo_position": "xyz789",
  "braintree_paypal_button_location_productpage_type_messaging_show": true,
  "braintree_paypal_button_location_productpage_type_messaging_text_color": "abc123",
  "braintree_paypal_button_location_productpage_type_paylater_color": "abc123",
  "braintree_paypal_button_location_productpage_type_paylater_label": "xyz789",
  "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789",
  "braintree_paypal_button_location_productpage_type_paylater_show": false,
  "braintree_paypal_button_location_productpage_type_paypal_color": "xyz789",
  "braintree_paypal_button_location_productpage_type_paypal_label": "abc123",
  "braintree_paypal_button_location_productpage_type_paypal_shape": "abc123",
  "braintree_paypal_button_location_productpage_type_paypal_show": true,
  "braintree_paypal_credit_uk_merchant_name": "abc123",
  "braintree_paypal_display_on_shopping_cart": true,
  "braintree_paypal_merchant_country": "abc123",
  "braintree_paypal_merchant_name_override": "abc123",
  "braintree_paypal_require_billing_address": true,
  "braintree_paypal_send_cart_line_items": true,
  "braintree_paypal_vault_active": true,
  "cart_expires_in_days": 987,
  "cart_gift_wrapping": "xyz789",
  "cart_merge_preference": "abc123",
  "cart_printed_card": "xyz789",
  "cart_summary_display_quantity": 123,
  "catalog_default_sort_by": "xyz789",
  "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "category_url_suffix": "xyz789",
  "check_money_order_enable_for_specific_countries": true,
  "check_money_order_enabled": false,
  "check_money_order_make_check_payable_to": "abc123",
  "check_money_order_max_order_total": "xyz789",
  "check_money_order_min_order_total": "abc123",
  "check_money_order_new_order_status": "abc123",
  "check_money_order_payment_from_specific_countries": "xyz789",
  "check_money_order_send_check_to": "abc123",
  "check_money_order_sort_order": 123,
  "check_money_order_title": "xyz789",
  "cms_home_page": "abc123",
  "cms_no_cookies": "abc123",
  "cms_no_route": "abc123",
  "code": "abc123",
  "configurable_product_image": "ITSELF",
  "configurable_thumbnail_source": "abc123",
  "contact_enabled": true,
  "copyright": "xyz789",
  "countries_with_required_region": "xyz789",
  "create_account_confirmation": true,
  "customer_access_token_lifetime": 123.45,
  "default_country": "abc123",
  "default_description": "abc123",
  "default_display_currency_code": "abc123",
  "default_keywords": "abc123",
  "default_title": "xyz789",
  "demonotice": 987,
  "display_product_prices_in_catalog": 123,
  "display_shipping_prices": 987,
  "display_state_if_optional": false,
  "enable_multiple_wishlists": "xyz789",
  "fixed_product_taxes_apply_tax_to_fpt": true,
  "fixed_product_taxes_display_prices_in_emails": 987,
  "fixed_product_taxes_display_prices_in_product_lists": 123,
  "fixed_product_taxes_display_prices_in_sales_modules": 987,
  "fixed_product_taxes_display_prices_on_product_view_page": 123,
  "fixed_product_taxes_enable": true,
  "fixed_product_taxes_include_fpt_in_subtotal": true,
  "front": "xyz789",
  "graphql_share_customer_group": true,
  "grid_per_page": 987,
  "grid_per_page_values": "abc123",
  "grouped_product_image": "ITSELF",
  "head_includes": "xyz789",
  "head_shortcut_icon": "abc123",
  "header_logo_src": "abc123",
  "id": 123,
  "is_checkout_agreements_enabled": false,
  "is_default_store": true,
  "is_default_store_group": true,
  "is_guest_checkout_enabled": true,
  "is_negotiable_quote_active": true,
  "is_one_page_checkout_enabled": true,
  "is_requisition_list_active": "abc123",
  "list_mode": "xyz789",
  "list_per_page": 987,
  "list_per_page_values": "xyz789",
  "locale": "xyz789",
  "logo_alt": "abc123",
  "logo_height": 123,
  "logo_width": 987,
  "magento_reward_general_is_enabled": "abc123",
  "magento_reward_general_is_enabled_on_front": "abc123",
  "magento_reward_general_min_points_balance": "abc123",
  "magento_reward_general_publish_history": "abc123",
  "magento_reward_points_invitation_customer": "abc123",
  "magento_reward_points_invitation_customer_limit": "abc123",
  "magento_reward_points_invitation_order": "abc123",
  "magento_reward_points_invitation_order_limit": "abc123",
  "magento_reward_points_newsletter": "abc123",
  "magento_reward_points_order": "abc123",
  "magento_reward_points_register": "xyz789",
  "magento_reward_points_review": "abc123",
  "magento_reward_points_review_limit": "abc123",
  "magento_wishlist_general_is_enabled": "xyz789",
  "max_items_in_order_summary": 987,
  "maximum_number_of_wishlists": "xyz789",
  "minicart_display": false,
  "minicart_max_items": 987,
  "minimum_password_length": "xyz789",
  "newsletter_enabled": false,
  "no_route": "abc123",
  "optional_zip_countries": "abc123",
  "order_cancellation_enabled": true,
  "order_cancellation_reasons": [CancellationReason],
  "orders_invoices_credit_memos_display_full_summary": true,
  "orders_invoices_credit_memos_display_grandtotal": true,
  "orders_invoices_credit_memos_display_price": 123,
  "orders_invoices_credit_memos_display_shipping_amount": 123,
  "orders_invoices_credit_memos_display_subtotal": 123,
  "orders_invoices_credit_memos_display_zero_tax": false,
  "payment_payflowpro_cc_vault_active": "abc123",
  "printed_card_price": "xyz789",
  "printed_card_priceV2": Money,
  "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "product_reviews_enabled": "abc123",
  "product_url_suffix": "abc123",
  "quickorder_active": true,
  "required_character_classes_number": "xyz789",
  "returns_enabled": "xyz789",
  "root_category_id": 123,
  "root_category_uid": "4",
  "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "sales_gift_wrapping": "abc123",
  "sales_printed_card": "abc123",
  "secure_base_link_url": "xyz789",
  "secure_base_media_url": "abc123",
  "secure_base_static_url": "xyz789",
  "secure_base_url": "xyz789",
  "send_friend": SendFriendConfiguration,
  "share_active_segments": false,
  "share_applied_cart_rule": true,
  "shopping_cart_display_full_summary": true,
  "shopping_cart_display_grand_total": false,
  "shopping_cart_display_price": 123,
  "shopping_cart_display_shipping": 987,
  "shopping_cart_display_subtotal": 987,
  "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
  "shopping_cart_display_zero_tax": true,
  "show_cms_breadcrumbs": 123,
  "store_code": "4",
  "store_group_code": 4,
  "store_group_name": "xyz789",
  "store_name": "xyz789",
  "store_sort_order": 123,
  "timezone": "xyz789",
  "title_prefix": "abc123",
  "title_separator": "abc123",
  "title_suffix": "xyz789",
  "use_store_in_url": true,
  "website_code": 4,
  "website_id": 987,
  "website_name": "xyz789",
  "weight_unit": "abc123",
  "welcome": "xyz789",
  "zero_subtotal_enable_for_specific_countries": true,
  "zero_subtotal_enabled": false,
  "zero_subtotal_new_order_status": "abc123",
  "zero_subtotal_payment_action": "abc123",
  "zero_subtotal_payment_from_specific_countries": "abc123",
  "zero_subtotal_sort_order": 123,
  "zero_subtotal_title": "xyz789"
}

StorefrontProperties

Indicates where an attribute can be displayed.

Fields

Example

{
  "position": 123,
  "use_in_layered_navigation": "NO",
  "use_in_product_listing": true,
  "use_in_search_results_layered_navigation": false,
  "visible_on_catalog_pages": true
}

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

SubmitNegotiableQuoteTemplateForReviewInput

Specifies the quote template properties to update.

Input Fields

Example

{
  "comment": "abc123",
  "max_order_commitment": 987,
  "min_order_commitment": 987,
  "name": "abc123",
  "reference_document_links": [
    NegotiableQuoteTemplateReferenceDocumentLinkInput
  ],
  "template_id": "4"
}

SubscribeEmailToNewsletterOutput

Contains the result of the subscribeEmailToNewsletter operation.

Fields

Example

{"status": "NOT_ACTIVE"}

SubscriptionStatusesEnum

Indicates the status of the request.

Values

Example

""NOT_ACTIVE""

SwatchData

Describes the swatch type and a value.

Fields

Example

{
  "type": "abc123",
  "value": "abc123"
}

SwatchDataInterface

Fields

Possible Types

Example

{"value": "xyz789"}

SwatchInputTypeEnum

Swatch attribute metadata input types.

Values

Example

""BOOLEAN""

SwatchLayerFilterItem

Fields

Example

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

SwatchLayerFilterItemInterface

Fields

Possible Types

Example

{"swatch_data": SwatchData}

SyncPaymentOrderInput

Synchronizes the payment order details

Input Fields

Example

{
  "cartId": "abc123",
  "id": "xyz789"
}