ProductInterface

Contains fields that are common to all types of products.

Fields

Possible Types

Example

{
  "activity": "abc123",
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "abc123",
  "collar": "abc123",
  "color": 987,
  "country_of_manufacture": "abc123",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 987,
  "features_bags": "xyz789",
  "format": 123,
  "gender": "xyz789",
  "gift_message_available": "xyz789",
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 123,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "abc123",
  "new": 987,
  "new_from_date": "abc123",
  "new_to_date": "xyz789",
  "only_x_left_in_stock": 987.65,
  "options_container": "abc123",
  "pattern": "xyz789",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 123.45,
  "related_products": [ProductInterface],
  "review_count": 123,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "xyz789",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 987.65,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "abc123",
  "style_bottom": "xyz789",
  "style_general": "xyz789",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 123.45,
  "tier_prices": [ProductTierPrices],
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

ProductLinks

An implementation of ProductLinksInterface.

Fields

Example

{
  "link_type": "xyz789",
  "linked_product_sku": "abc123",
  "linked_product_type": "abc123",
  "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": 987,
  "sku": "abc123"
}

ProductMediaGalleryEntriesContent

Contains an image in base64 format and basic information about the image.

Fields

Example

{
  "base64_encoded_data": "xyz789",
  "name": "abc123",
  "type": "abc123"
}

ProductMediaGalleryEntriesVideoContent

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

Fields

Example

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

ProductPrice

Represents a product price.

Fields

Example

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

ProductPrices

Deprecated. Use PriceRange instead. Contains the regular price of an item, as well as its minimum and maximum prices. Only composite products, which include bundle, configurable, and grouped products, can contain a minimum and maximum price.

Fields

Example

{
  "maximalPrice": Price,
  "minimalPrice": Price,
  "regularPrice": Price
}

ProductReview

Contains details of a product review.

Fields

Example

{
  "average_rating": 123.45,
  "created_at": "xyz789",
  "nickname": "abc123",
  "product": ProductInterface,
  "ratings_breakdown": [ProductReviewRating],
  "summary": "abc123",
  "text": "xyz789"
}

ProductReviewRating

Contains data about a single aspect of a product review.

Fields

Example

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

ProductReviewRatingInput

Contains the reviewer's rating for a single aspect of a review.

Input Fields

Example

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

ProductReviewRatingMetadata

Contains details about a single aspect of a product review.

Fields

Example

{
  "id": "abc123",
  "name": "abc123",
  "values": [ProductReviewRatingValueMetadata]
}

ProductReviewRatingValueMetadata

Contains details about a single value in a product review.

Fields

Example

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

ProductReviewRatingsMetadata

Contains an array of metadata about each aspect of a product review.

Fields

Example

{"items": [ProductReviewRatingMetadata]}

ProductReviews

Contains an array of product reviews.

Fields

Example

{
  "items": [ProductReview],
  "page_info": SearchResultPageInfo
}

ProductStockStatus

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

Values

Example

""IN_STOCK""

ProductTierPrices

Deprecated. Use TierPrice instead. Defines a tier price, which is a quantity discount offered to a specific customer group.

Fields

Example

{
  "customer_group_id": "abc123",
  "percentage_value": 123.45,
  "qty": 987.65,
  "value": 123.45,
  "website_id": 123.45
}

ProductVideo

Contains information about a product video.

Fields

Example

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

Products

Contains the results of a products query.

Fields

Example

{
  "aggregations": [Aggregation],
  "filters": [LayerFilter],
  "items": [ProductInterface],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "suggestions": [SearchSuggestion],
  "total_count": 987
}

PurchaseOrder

Contains details about a purchase order.

Fields

Example

{
  "approval_flow": [PurchaseOrderRuleApprovalFlow],
  "available_actions": ["REJECT"],
  "comments": [PurchaseOrderComment],
  "created_at": "xyz789",
  "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": "xyz789", "type": "NOT_FOUND"}

PurchaseOrderApprovalFlowEvent

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

Fields

Example

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

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": "xyz789",
  "created_by": "abc123",
  "description": "xyz789",
  "name": "abc123",
  "status": "ENABLED",
  "uid": "4",
  "updated_at": "abc123"
}

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

PurchaseOrderApprovalRuleInput

Defines a new purchase order approval rule.

Input Fields

Example

{
  "applies_to": [4],
  "approvers": ["4"],
  "condition": CreatePurchaseOrderApprovalRuleConditionInput,
  "description": "xyz789",
  "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": 123
}

PurchaseOrderComment

Contains details about a comment.

Fields

Example

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

PurchaseOrderErrorType

Values

Example

""NOT_FOUND""

PurchaseOrderHistoryItem

Contains details about a status change.

Fields

Example

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

PurchaseOrderRuleApprovalFlow

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

Fields

Example

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

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": true,
  "created_date": FilterRangeTypeInput,
  "require_my_approval": true,
  "status": "PENDING"
}

Region

Fields

Example

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

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

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}

ReorderItemsOutput

Contains the cart and any errors after adding products.

Fields

Example

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

RequestNegotiableQuoteInput

Defines properties of a negotiable quote request.

Input Fields

Example

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

RequestNegotiableQuoteOutput

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

Fields

Example

{"quote": NegotiableQuote}

RequestReturnInput

Contains information needed to start a return request.

Input Fields

Example

{
  "comment_text": "xyz789",
  "contact_email": "xyz789",
  "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": "abc123",
  "items": RequistionListItems,
  "items_count": 987,
  "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": 123.45,
  "uid": 4
}

RequisitionListItemsInput

Defines the items to add.

Input Fields

Example

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

RequisitionLists

Defines customer requisition lists.

Fields

Example

{
  "items": [RequisitionList],
  "page_info": SearchResultPageInfo,
  "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": "xyz789",
  "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": "abc123",
  "created_at": "xyz789",
  "text": "xyz789",
  "uid": 4
}

ReturnCustomAttribute

Contains details about a ReturnCustomerAttribute object.

Fields

Example

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

ReturnCustomer

The customer information for the return.

Fields

Example

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

ReturnItem

Contains details about a product being returned.

Fields

Example

{
  "custom_attributes": [ReturnCustomAttribute],
  "order_item": OrderItemInterface,
  "quantity": 123.45,
  "request_quantity": 987.65,
  "status": "PENDING",
  "uid": "4"
}

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": "abc123",
  "contact_name": "xyz789",
  "country": Country,
  "postcode": "abc123",
  "region": Region,
  "street": ["abc123"],
  "telephone": "abc123"
}

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

RewardPointsBalanceHistoryItem

Contain details about the reward points transaction.

Fields

Example

{
  "balance": RewardPointsAmount,
  "change_reason": "abc123",
  "date": "abc123",
  "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": 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": 987,
  "relative_url": "xyz789",
  "type": "CMS_PAGE"
}

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

SearchSuggestion

A string that contains search suggestion

Fields

Example

{"search": "abc123"}

SelectedBundleOption

Contains details about a selected bundle option.

Fields

Example

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

SelectedBundleOptionValue

Contains details about a value for a selected bundle option.

Fields

Example

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

SelectedCustomAttributeInput

Contains details about an attribute the buyer selected.

Input Fields

Example

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

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": "abc123",
  "price": CartItemSelectedOptionValuePrice,
  "value": "xyz789"
}

SelectedPaymentMethod

Describes the payment method the shopper selected.

Fields

Example

{
  "code": "xyz789",
  "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": "xyz789",
  "method_code": "abc123",
  "method_title": "abc123",
  "price_excl_tax": Money,
  "price_incl_tax": Money
}

SendEmailToFriendInput

Defines the referenced product and the email sender and recipients.

Input Fields

Example

{
  "product_id": 987,
  "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": "abc123",
  "name": "abc123"
}

SendEmailToFriendRecipientInput

Contains details about a recipient.

Input Fields

Example

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

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

SendFriendConfiguration

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

Fields

Example

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

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

SetBillingAddressOnCartOutput

Contains details about the cart after setting the billing address.

Fields

Example

{"cart": Cart}

SetGiftOptionsOnCartInput

Defines the gift options applied to the cart.

Input Fields

Example

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

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}

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}

SetPaymentMethodAndPlaceOrderInput

Applies a payment method to the quote.

Input Fields

Example

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

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

ShippingAddressInput

Defines a single shipping address.

Input Fields

Example

{
  "address": CartAddressInput,
  "customer_address_id": 987,
  "customer_notes": "abc123",
  "pickup_location_code": "abc123"
}

ShippingCartAddress

Contains shipping addresses and methods.

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "cart_items": [CartItemQuantity],
  "cart_items_v2": [CartItemInterface],
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "customer_notes": "xyz789",
  "firstname": "abc123",
  "items_weight": 123.45,
  "lastname": "abc123",
  "pickup_location_code": "abc123",
  "postcode": "xyz789",
  "region": CartAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["xyz789"],
  "telephone": "abc123",
  "uid": "abc123",
  "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": "xyz789"
}

SimpleCartItem

An implementation for simple product cart items.

Fields

Example

{
  "available_gift_wrapping": [GiftWrapping],
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "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

{
  "activity": "abc123",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "xyz789",
  "climate": "abc123",
  "collar": "xyz789",
  "color": 123,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 987,
  "features_bags": "abc123",
  "format": 987,
  "gender": "abc123",
  "gift_message_available": "xyz789",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 123,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "name": "abc123",
  "new": 123,
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "pattern": "abc123",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 123,
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "abc123",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 123.45,
  "special_to_date": "abc123",
  "staged": false,
  "stock_status": "IN_STOCK",
  "strap_bags": "abc123",
  "style_bags": "abc123",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "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": "xyz789",
  "customizable_options": [SelectedCustomizableOption],
  "description": "xyz789",
  "id": 4,
  "product": ProductInterface,
  "quantity": 987.65
}

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

StoreConfig

Contains information about a store's configuration.

Fields

Example

{
  "absolute_footer": "abc123",
  "allow_gift_receipt": "abc123",
  "allow_gift_wrapping_on_order": "abc123",
  "allow_gift_wrapping_on_order_items": "abc123",
  "allow_guests_to_write_product_reviews": "abc123",
  "allow_items": "xyz789",
  "allow_order": "abc123",
  "allow_printed_card": "xyz789",
  "autocomplete_on_storefront": true,
  "base_currency_code": "xyz789",
  "base_link_url": "xyz789",
  "base_media_url": "abc123",
  "base_static_url": "abc123",
  "base_url": "abc123",
  "braintree_cc_vault_active": "abc123",
  "cart_gift_wrapping": "abc123",
  "cart_printed_card": "abc123",
  "catalog_default_sort_by": "abc123",
  "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "category_url_suffix": "abc123",
  "check_money_order_enable_for_specific_countries": true,
  "check_money_order_enabled": false,
  "check_money_order_make_check_payable_to": "xyz789",
  "check_money_order_max_order_total": "xyz789",
  "check_money_order_min_order_total": "xyz789",
  "check_money_order_new_order_status": "xyz789",
  "check_money_order_payment_from_specific_countries": "abc123",
  "check_money_order_send_check_to": "abc123",
  "check_money_order_sort_order": 987,
  "check_money_order_title": "abc123",
  "cms_home_page": "xyz789",
  "cms_no_cookies": "xyz789",
  "cms_no_route": "abc123",
  "code": "xyz789",
  "configurable_thumbnail_source": "xyz789",
  "copyright": "abc123",
  "default_description": "abc123",
  "default_display_currency_code": "xyz789",
  "default_keywords": "abc123",
  "default_title": "xyz789",
  "demonotice": 123,
  "enable_multiple_wishlists": "abc123",
  "front": "abc123",
  "grid_per_page": 987,
  "grid_per_page_values": "xyz789",
  "head_includes": "abc123",
  "head_shortcut_icon": "abc123",
  "header_logo_src": "abc123",
  "id": 123,
  "is_default_store": false,
  "is_default_store_group": false,
  "is_negotiable_quote_active": false,
  "is_requisition_list_active": "xyz789",
  "list_mode": "abc123",
  "list_per_page": 123,
  "list_per_page_values": "abc123",
  "locale": "xyz789",
  "logo_alt": "abc123",
  "logo_height": 987,
  "logo_width": 123,
  "magento_reward_general_is_enabled": "xyz789",
  "magento_reward_general_is_enabled_on_front": "xyz789",
  "magento_reward_general_min_points_balance": "abc123",
  "magento_reward_general_publish_history": "xyz789",
  "magento_reward_points_invitation_customer": "xyz789",
  "magento_reward_points_invitation_customer_limit": "xyz789",
  "magento_reward_points_invitation_order": "xyz789",
  "magento_reward_points_invitation_order_limit": "abc123",
  "magento_reward_points_newsletter": "xyz789",
  "magento_reward_points_order": "xyz789",
  "magento_reward_points_register": "abc123",
  "magento_reward_points_review": "xyz789",
  "magento_reward_points_review_limit": "xyz789",
  "magento_wishlist_general_is_enabled": "abc123",
  "maximum_number_of_wishlists": "xyz789",
  "minimum_password_length": "abc123",
  "no_route": "xyz789",
  "payment_payflowpro_cc_vault_active": "xyz789",
  "printed_card_price": "abc123",
  "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "product_reviews_enabled": "xyz789",
  "product_url_suffix": "xyz789",
  "required_character_classes_number": "abc123",
  "returns_enabled": "xyz789",
  "root_category_id": 987,
  "root_category_uid": "4",
  "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "sales_gift_wrapping": "xyz789",
  "sales_printed_card": "abc123",
  "secure_base_link_url": "abc123",
  "secure_base_media_url": "xyz789",
  "secure_base_static_url": "abc123",
  "secure_base_url": "abc123",
  "send_friend": SendFriendConfiguration,
  "show_cms_breadcrumbs": 123,
  "store_code": 4,
  "store_group_code": 4,
  "store_group_name": "abc123",
  "store_name": "abc123",
  "store_sort_order": 123,
  "timezone": "xyz789",
  "title_prefix": "xyz789",
  "title_separator": "abc123",
  "title_suffix": "abc123",
  "use_store_in_url": true,
  "website_code": "4",
  "website_id": 987,
  "website_name": "xyz789",
  "weight_unit": "abc123",
  "welcome": "abc123",
  "zero_subtotal_enable_for_specific_countries": false,
  "zero_subtotal_enabled": true,
  "zero_subtotal_new_order_status": "xyz789",
  "zero_subtotal_payment_action": "xyz789",
  "zero_subtotal_payment_from_specific_countries": "xyz789",
  "zero_subtotal_sort_order": 987,
  "zero_subtotal_title": "abc123"
}

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

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

"abc123"

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

SwatchDataInterface

Fields

Possible Types

Example

{"value": "abc123"}

SwatchLayerFilterItem

Fields

Example

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

SwatchLayerFilterItemInterface

Fields

Possible Types

Example

{"swatch_data": SwatchData}

TaxItem

Contains tax item details.

Fields

Example

{
  "amount": Money,
  "rate": 123.45,
  "title": "xyz789"
}

TextSwatchData

Fields

Example

{"value": "xyz789"}

TierPrice

Defines a price based on the quantity purchased.

Fields

Example

{
  "discount": ProductDiscount,
  "final_price": Money,
  "quantity": 123.45
}

UpdateCartItemsInput

Modifies the specified items in the cart.

Input Fields

Example

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

UpdateCartItemsOutput

Contains details about the cart after updating items.

Fields

Example

{"cart": Cart}

UpdateCompanyOutput

Contains the response to the request to update the company.

Fields

Example

{"company": Company}

UpdateCompanyRoleOutput

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

Fields

Example

{"role": CompanyRole}

UpdateCompanyStructureOutput

Contains the response to the request to update the company structure.

Fields

Example

{"company": Company}

UpdateCompanyTeamOutput

Contains the response to the request to update a company team.

Fields

Example

{"team": CompanyTeam}

UpdateCompanyUserOutput

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

Fields

Example

{"user": Customer}

UpdateGiftRegistryInput

Defines updates to a GiftRegistry object.

Input Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "abc123",
  "message": "abc123",
  "privacy_settings": "PRIVATE",
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

UpdateGiftRegistryItemInput

Defines updates to an item in a gift registry.

Input Fields

Example

{
  "gift_registry_item_uid": 4,
  "note": "abc123",
  "quantity": 123.45
}

UpdateGiftRegistryItemsOutput

Contains the results of a request to update gift registry items.

Fields

Example

{"gift_registry": GiftRegistry}

UpdateGiftRegistryOutput

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

Fields

Example

{"gift_registry": GiftRegistry}

UpdateGiftRegistryRegistrantInput

Defines updates to an existing registrant.

Input Fields

Example

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

UpdateGiftRegistryRegistrantsOutput

Contains the results a request to update registrants.

Fields

Example

{"gift_registry": GiftRegistry}

UpdateNegotiableQuoteItemsQuantityOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

UpdateNegotiableQuoteQuantitiesInput

Specifies the items to update.

Input Fields

Example

{
  "items": [NegotiableQuoteItemQuantityInput],
  "quote_uid": 4
}

UpdateProductsInWishlistOutput

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

Fields

Example

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

UpdatePurchaseOrderApprovalRuleInput

Defines the changes to be made to an approval rule.

Input Fields

Example

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

UpdateRequisitionListInput

An input object that defines which requistion list characteristics to update.

Input Fields

Example

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

UpdateRequisitionListItemsInput

Defines which items in a requisition list to update.

Input Fields

Example

{
  "entered_options": [EnteredOptionInput],
  "item_id": 4,
  "quantity": 123.45,
  "selected_options": ["xyz789"]
}

UpdateRequisitionListItemsOutput

Output of the request to update items in the specified requisition list.

Fields

Example

{"requisition_list": RequisitionList}

UpdateRequisitionListOutput

Output of the request to rename the requisition list.

Fields

Example

{"requisition_list": RequisitionList}

UpdateWishlistOutput

Contains the name and visibility of an updated wish list.

Fields

Example

{
  "name": "abc123",
  "uid": 4,
  "visibility": "PUBLIC"
}

UrlRewrite

Contains URL rewrite details.

Fields

Example

{
  "parameters": [HttpQueryParameter],
  "url": "xyz789"
}

UrlRewriteEntityTypeEnum

This enumeration defines the entity type.

Values

Example

""CMS_PAGE""

UseInLayeredNavigationOptions

Defines whether the attribute is filterable in layered navigation.

Values

Example

""NO""

ValidatePurchaseOrderError

Contains details about a failed validation attempt.

Fields

Example

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

ValidatePurchaseOrderErrorType

Values

Example

""NOT_FOUND""

ValidatePurchaseOrdersInput

Defines the purchase orders to be validated.

Input Fields

Example

{"purchase_order_uids": ["4"]}

ValidatePurchaseOrdersOutput

Contains the results of validation attempts.

Fields

Example

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

VaultTokenInput

Contains required input for payment methods with Vault support.

Input Fields

Example

{"public_hash": "xyz789"}

VirtualCartItem

An implementation for virtual product cart items.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "errors": [CartItemError],
  "id": "abc123",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

VirtualProduct

Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory.

Fields

Example

{
  "activity": "xyz789",
  "attribute_set_id": 123,
  "canonical_url": "abc123",
  "categories": [CategoryInterface],
  "category_gear": "xyz789",
  "climate": "xyz789",
  "collar": "xyz789",
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 123,
  "features_bags": "xyz789",
  "format": 123,
  "gender": "abc123",
  "gift_message_available": "xyz789",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 123,
  "material": "abc123",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "name": "xyz789",
  "new": 987,
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 987,
  "rating_summary": 123.45,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 123,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "xyz789",
  "sleeve": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 123.45,
  "special_to_date": "abc123",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "abc123",
  "style_bottom": "xyz789",
  "style_general": "abc123",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "abc123",
  "uid": 4,
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website]
}

VirtualProductCartItemInput

Defines a single product to add to the cart.

Input Fields

Example

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

VirtualRequisitionListItem

Contains details about virtual products added to a requisition list.

Fields

Example

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

VirtualWishlistItem

Contains a virtual product wish list item.

Fields

Example

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

Website

Deprecated. It should not be used on the storefront. Contains information about a website.

Fields

Example

{
  "code": "xyz789",
  "default_group_id": "abc123",
  "id": 123,
  "is_default": true,
  "name": "abc123",
  "sort_order": 123
}

WishListUserInputError

An error encountered while performing operations with WishList.

Fields

Example

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

WishListUserInputErrorType

A list of possible error types.

Values

Example

""PRODUCT_NOT_FOUND""

Wishlist

Contains a customer wish list.

Fields

Example

{
  "id": 4,
  "items": [WishlistItem],
  "items_count": 123,
  "items_v2": WishlistItems,
  "name": "xyz789",
  "sharing_code": "xyz789",
  "updated_at": "abc123",
  "visibility": "PUBLIC"
}

WishlistCartUserInputError

Contains details about errors encountered when a customer added wish list items to the cart.

Fields

Example

{
  "code": "PRODUCT_NOT_FOUND",
  "message": "xyz789",
  "wishlistId": "4",
  "wishlistItemId": "4"
}

WishlistCartUserInputErrorType

A list of possible error types.

Values

Example

""PRODUCT_NOT_FOUND""

WishlistItem

Contains details about a wish list item.

Fields

Example

{
  "added_at": "abc123",
  "description": "xyz789",
  "id": 987,
  "product": ProductInterface,
  "qty": 987.65
}

WishlistItemCopyInput

Specifies the IDs of items to copy and their quantities.

Input Fields

Example

{
  "quantity": 987.65,
  "wishlist_item_id": "4"
}

WishlistItemInput

Defines the items to add to a wish list.

Input Fields

Example

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

WishlistItemInterface

The interface for wish list items.

Fields

Possible Types

Example

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

WishlistItemMoveInput

Specifies the IDs of the items to move and their quantities.

Input Fields

Example

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

WishlistItemUpdateInput

Defines updates to items in a wish list.

Input Fields

Example

{
  "description": "xyz789",
  "entered_options": [EnteredOptionInput],
  "quantity": 987.65,
  "selected_options": ["4"],
  "wishlist_item_id": 4
}

WishlistItems

Contains an array of items in a wish list.

Fields

Example

{
  "items": [WishlistItemInterface],
  "page_info": SearchResultPageInfo
}

WishlistOutput

Deprecated: Use the Wishlist type instead.

Fields

Example

{
  "items": [WishlistItem],
  "items_count": 123,
  "name": "abc123",
  "sharing_code": "xyz789",
  "updated_at": "xyz789"
}

WishlistVisibilityEnum

Defines the wish list visibility types.

Values

Example

""PUBLIC""

createEmptyCartInput

Assigns a specific cart_id to the empty cart.

Input Fields

Example

{"cart_id": "abc123"}