ShippingAddressInput

Defines a single shipping address.

Input Fields

Example

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

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,
  "custom_attributes": [AttributeValueInterface],
  "customer_notes": "abc123",
  "fax": "xyz789",
  "firstname": "abc123",
  "id": 987,
  "items_weight": 987.65,
  "lastname": "xyz789",
  "middlename": "xyz789",
  "pickup_location_code": "abc123",
  "postcode": "abc123",
  "prefix": "abc123",
  "region": CartAddressRegion,
  "same_as_billing": false,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "xyz789",
  "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": "xyz789",
  "method_code": "xyz789"
}

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

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

SmartButtonMethodInput

Smart button payment inputs

Input Fields

Example

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

SmartButtonsConfig

Fields

Example

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

SortEnum

Indicates whether to return results in ascending or descending order.

Values

Example

""ASC""

SortField

Defines a possible sort field.

Fields

Example

{
  "label": "abc123",
  "value": "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": "abc123",
  "allow_gift_wrapping_on_order_items": "xyz789",
  "allow_guests_to_write_product_reviews": "xyz789",
  "allow_items": "abc123",
  "allow_order": "abc123",
  "allow_printed_card": "xyz789",
  "autocomplete_on_storefront": true,
  "base_currency_code": "abc123",
  "base_link_url": "xyz789",
  "base_media_url": "abc123",
  "base_static_url": "xyz789",
  "base_url": "abc123",
  "braintree_3dsecure_allowspecific": true,
  "braintree_3dsecure_always_request_3ds": false,
  "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": "xyz789",
  "braintree_applepay_vault_active": false,
  "braintree_cc_vault_active": "xyz789",
  "braintree_cc_vault_cvv": false,
  "braintree_environment": "abc123",
  "braintree_googlepay_btn_color": "xyz789",
  "braintree_googlepay_cctypes": "xyz789",
  "braintree_googlepay_merchant_id": "abc123",
  "braintree_googlepay_vault_active": true,
  "braintree_local_payment_allowed_methods": "abc123",
  "braintree_local_payment_fallback_button_text": "abc123",
  "braintree_local_payment_redirect_on_fail": "abc123",
  "braintree_merchant_account_id": "abc123",
  "braintree_paypal_button_location_cart_type_credit_color": "xyz789",
  "braintree_paypal_button_location_cart_type_credit_label": "xyz789",
  "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": "xyz789",
  "braintree_paypal_button_location_cart_type_messaging_logo": "abc123",
  "braintree_paypal_button_location_cart_type_messaging_logo_position": "abc123",
  "braintree_paypal_button_location_cart_type_messaging_show": true,
  "braintree_paypal_button_location_cart_type_messaging_text_color": "xyz789",
  "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": "xyz789",
  "braintree_paypal_button_location_cart_type_paylater_show": false,
  "braintree_paypal_button_location_cart_type_paypal_color": "abc123",
  "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": true,
  "braintree_paypal_button_location_checkout_type_credit_color": "abc123",
  "braintree_paypal_button_location_checkout_type_credit_label": "xyz789",
  "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789",
  "braintree_paypal_button_location_checkout_type_credit_show": true,
  "braintree_paypal_button_location_checkout_type_messaging_layout": "xyz789",
  "braintree_paypal_button_location_checkout_type_messaging_logo": "abc123",
  "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123",
  "braintree_paypal_button_location_checkout_type_messaging_show": true,
  "braintree_paypal_button_location_checkout_type_messaging_text_color": "xyz789",
  "braintree_paypal_button_location_checkout_type_paylater_color": "abc123",
  "braintree_paypal_button_location_checkout_type_paylater_label": "xyz789",
  "braintree_paypal_button_location_checkout_type_paylater_shape": "abc123",
  "braintree_paypal_button_location_checkout_type_paylater_show": true,
  "braintree_paypal_button_location_checkout_type_paypal_color": "abc123",
  "braintree_paypal_button_location_checkout_type_paypal_label": "xyz789",
  "braintree_paypal_button_location_checkout_type_paypal_shape": "xyz789",
  "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": "abc123",
  "braintree_paypal_button_location_productpage_type_credit_show": false,
  "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": "xyz789",
  "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": true,
  "braintree_paypal_button_location_productpage_type_paypal_color": "abc123",
  "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": false,
  "braintree_paypal_credit_uk_merchant_name": "abc123",
  "braintree_paypal_display_on_shopping_cart": false,
  "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_printed_card": "abc123",
  "cart_summary_display_quantity": 987,
  "catalog_default_sort_by": "abc123",
  "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS",
  "category_url_suffix": "xyz789",
  "check_money_order_enable_for_specific_countries": false,
  "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": "abc123",
  "check_money_order_payment_from_specific_countries": "xyz789",
  "check_money_order_send_check_to": "xyz789",
  "check_money_order_sort_order": 987,
  "check_money_order_title": "abc123",
  "cms_home_page": "abc123",
  "cms_no_cookies": "abc123",
  "cms_no_route": "abc123",
  "code": "abc123",
  "configurable_product_image": "ITSELF",
  "configurable_thumbnail_source": "xyz789",
  "contact_enabled": true,
  "copyright": "xyz789",
  "countries_with_required_region": "xyz789",
  "create_account_confirmation": true,
  "customer_access_token_lifetime": 987.65,
  "default_country": "abc123",
  "default_description": "xyz789",
  "default_display_currency_code": "xyz789",
  "default_keywords": "xyz789",
  "default_title": "abc123",
  "demonotice": 987,
  "display_product_prices_in_catalog": 987,
  "display_shipping_prices": 123,
  "display_state_if_optional": false,
  "enable_multiple_wishlists": "abc123",
  "fixed_product_taxes_apply_tax_to_fpt": false,
  "fixed_product_taxes_display_prices_in_emails": 123,
  "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": 987,
  "fixed_product_taxes_enable": false,
  "fixed_product_taxes_include_fpt_in_subtotal": false,
  "front": "xyz789",
  "graphql_share_all_customer_groups": false,
  "graphql_share_customer_group": false,
  "grid_per_page": 987,
  "grid_per_page_values": "xyz789",
  "grouped_product_image": "ITSELF",
  "head_includes": "abc123",
  "head_shortcut_icon": "xyz789",
  "header_logo_src": "xyz789",
  "id": 123,
  "is_checkout_agreements_enabled": true,
  "is_default_store": true,
  "is_default_store_group": false,
  "is_guest_checkout_enabled": true,
  "is_negotiable_quote_active": false,
  "is_one_page_checkout_enabled": true,
  "is_requisition_list_active": "xyz789",
  "list_mode": "xyz789",
  "list_per_page": 123,
  "list_per_page_values": "xyz789",
  "locale": "abc123",
  "logo_alt": "xyz789",
  "logo_height": 987,
  "logo_width": 123,
  "magento_reward_general_is_enabled": "xyz789",
  "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": "xyz789",
  "magento_reward_points_invitation_customer_limit": "abc123",
  "magento_reward_points_invitation_order": "xyz789",
  "magento_reward_points_invitation_order_limit": "xyz789",
  "magento_reward_points_newsletter": "xyz789",
  "magento_reward_points_order": "xyz789",
  "magento_reward_points_register": "abc123",
  "magento_reward_points_review": "abc123",
  "magento_reward_points_review_limit": "xyz789",
  "magento_wishlist_general_is_enabled": "abc123",
  "max_items_in_order_summary": 987,
  "maximum_number_of_wishlists": "abc123",
  "minicart_display": true,
  "minicart_max_items": 123,
  "minimum_password_length": "abc123",
  "newsletter_enabled": false,
  "no_route": "abc123",
  "optional_zip_countries": "xyz789",
  "order_cancellation_enabled": false,
  "order_cancellation_reasons": [CancellationReason],
  "orders_invoices_credit_memos_display_full_summary": true,
  "orders_invoices_credit_memos_display_grandtotal": false,
  "orders_invoices_credit_memos_display_price": 123,
  "orders_invoices_credit_memos_display_shipping_amount": 987,
  "orders_invoices_credit_memos_display_subtotal": 987,
  "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": "xyz789",
  "quickorder_active": true,
  "required_character_classes_number": "xyz789",
  "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": "xyz789",
  "secure_base_link_url": "abc123",
  "secure_base_media_url": "xyz789",
  "secure_base_static_url": "abc123",
  "secure_base_url": "xyz789",
  "send_friend": SendFriendConfiguration,
  "share_all_catalog_rules": true,
  "share_all_sales_rule": true,
  "share_applied_catalog_rules": true,
  "share_applied_sales_rule": false,
  "shopping_cart_display_full_summary": true,
  "shopping_cart_display_grand_total": false,
  "shopping_cart_display_price": 987,
  "shopping_cart_display_shipping": 987,
  "shopping_cart_display_subtotal": 123,
  "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX",
  "shopping_cart_display_zero_tax": false,
  "show_cms_breadcrumbs": 987,
  "store_code": "4",
  "store_group_code": 4,
  "store_group_name": "abc123",
  "store_name": "xyz789",
  "store_sort_order": 123,
  "timezone": "xyz789",
  "title_prefix": "abc123",
  "title_separator": "abc123",
  "title_suffix": "xyz789",
  "use_store_in_url": false,
  "website_code": "4",
  "website_id": 123,
  "website_name": "xyz789",
  "weight_unit": "xyz789",
  "welcome": "abc123",
  "zero_subtotal_enable_for_specific_countries": false,
  "zero_subtotal_enabled": false,
  "zero_subtotal_new_order_status": "abc123",
  "zero_subtotal_payment_action": "abc123",
  "zero_subtotal_payment_from_specific_countries": "xyz789",
  "zero_subtotal_sort_order": 123,
  "zero_subtotal_title": "xyz789"
}

StorefrontProperties

Indicates where an attribute can be displayed.

Fields

Example

{
  "position": 987,
  "use_in_layered_navigation": "NO",
  "use_in_product_listing": false,
  "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"

SubmitNegotiableQuoteTemplateForReviewInput

Specifies the quote template properties to update.

Input Fields

Example

{
  "comment": "xyz789",
  "max_order_commitment": 123,
  "min_order_commitment": 123,
  "name": "xyz789",
  "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": "xyz789",
  "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": "abc123"
}

SwatchLayerFilterItemInterface

Fields

Possible Types

Example

{"swatch_data": SwatchData}

SyncPaymentOrderInput

Synchronizes the payment order details

Input Fields

Example

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

TaxItem

Contains tax item details.

Fields

Example

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

TaxWrappingEnum

Values

Example

""DISPLAY_EXCLUDING_TAX""

TextSwatchData

Fields

Example

{"value": "xyz789"}

ThreeDSMode

3D Secure mode.

Values

Example

""OFF""

TierPrice

Defines a price based on the quantity purchased.

Fields

Example

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

UpdateCartItemsInput

Modifies the specified items in the cart.

Input Fields

Example

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

UpdateCartItemsOutput

Contains details about the cart after updating items.

Fields

Example

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

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

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

UpdateNegotiableQuoteTemplateItemsQuantityOutput

Contains the updated negotiable quote template.

Fields

Example

{"quote_template": NegotiableQuoteTemplate}

UpdateNegotiableQuoteTemplateQuantitiesInput

Specifies the items to update.

Input Fields

Example

{
  "items": [NegotiableQuoteTemplateItemQuantityInput],
  "template_id": "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": "abc123",
  "name": "abc123",
  "status": "ENABLED",
  "uid": "4"
}

UpdateRequisitionListInput

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

Input Fields

Example

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

UpdateRequisitionListItemsInput

Defines which items in a requisition list to update.

Input Fields

Example

{
  "entered_options": [EnteredOptionInput],
  "item_id": "4",
  "quantity": 987.65,
  "selected_options": ["abc123"]
}

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

UrlRewrite

Contains URL rewrite details.

Fields

Example

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

UrlRewriteEntityTypeEnum

This enumeration defines the entity type.

Values

Example

""CMS_PAGE""

UseInLayeredNavigationOptions

Defines whether the attribute is filterable in layered navigation.

Values

Example

""NO""

UserCompaniesInput

Defines the input for returning matching companies the customer is assigned to.

Input Fields

Example

{
  "currentPage": 987,
  "pageSize": 987,
  "sort": [CompaniesSortInput]
}

UserCompaniesOutput

An object that contains a list of companies customer is assigned to.

Fields

Example

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

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

ValidationRule

Defines a customer attribute validation rule.

Fields

Example

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

ValidationRuleEnum

List of validation rule names applied to a customer attribute.

Values

Example

""DATE_RANGE_MAX""

VaultConfigOutput

Retrieves the vault configuration

Fields

Example

{"credit_card": VaultCreditCardConfig}

VaultCreditCardConfig

Fields

Example

{
  "is_vault_enabled": true,
  "sdk_params": [SDKParams],
  "three_ds_mode": "OFF"
}

VaultMethodInput

Vault payment inputs

Input Fields

Example

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

VaultSetupTokenInput

The payment source information

Input Fields

Example

{"payment_source": PaymentSourceInput}

VaultTokenInput

Contains required input for payment methods with Vault support.

Input Fields

Example

{"public_hash": "abc123"}

VirtualCartItem

An implementation for virtual product cart items.

Fields

Example

{
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "xyz789",
  "is_available": false,
  "max_qty": 987.65,
  "min_qty": 123.45,
  "not_available_message": "xyz789",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "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": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "abc123",
  "color": 987,
  "country_of_manufacture": "abc123",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "eco_collection": 123,
  "erin_recommends": 987,
  "features_bags": "xyz789",
  "format": 123,
  "gender": "xyz789",
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 987,
  "material": "abc123",
  "max_sale_qty": 987.65,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "xyz789",
  "meta_keyword": "abc123",
  "meta_title": "xyz789",
  "min_sale_qty": 987.65,
  "name": "abc123",
  "new": 987,
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "pattern": "xyz789",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 987,
  "quantity": 123.45,
  "rating_summary": 987.65,
  "redirect_code": 987,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 987,
  "reviews": ProductReviews,
  "rules": [CatalogRule],
  "sale": 123,
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "abc123",
  "sleeve": "abc123",
  "small_image": ProductImage,
  "special_from_date": "xyz789",
  "special_price": 987.65,
  "special_to_date": "abc123",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "xyz789",
  "style_bottom": "abc123",
  "style_general": "xyz789",
  "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": "abc123",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "xyz789",
  "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": "abc123",
  "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": "xyz789",
  "id": 123,
  "is_default": true,
  "name": "abc123",
  "sort_order": 987
}

WishListUserInputError

An error encountered while performing operations with WishList.

Fields

Example

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

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": 987,
  "items_v2": WishlistItems,
  "name": "abc123",
  "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": "xyz789",
  "description": "abc123",
  "id": 987,
  "product": ProductInterface,
  "qty": 123.45
}

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": "abc123",
  "quantity": 987.65,
  "selected_options": [4],
  "sku": "xyz789"
}

WishlistItemInterface

The interface for wish list items.

Fields

Possible Types

Example

{
  "added_at": "abc123",
  "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": "abc123",
  "entered_options": [EnteredOptionInput],
  "quantity": 123.45,
  "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": "abc123"
}

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