Types

AcceptNegotiableQuoteTemplateInput

Specifies the quote template id to accept quote template.

Input Fields

Example

{"template_id": 4}

AddBundleProductsToCartInput

Defines the bundle products to add to the cart.

Input Fields

Example

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

AddBundleProductsToCartOutput

Contains details about the cart after adding bundle products.

Fields

Example

{"cart": Cart}

AddConfigurableProductsToCartInput

Defines the configurable products to add to the cart.

Input Fields

Example

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

AddConfigurableProductsToCartOutput

Contains details about the cart after adding configurable products.

Fields

Example

{"cart": Cart}

AddDownloadableProductsToCartInput

Input Fields

Example

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

AddDownloadableProductsToCartOutput

Contains details about the cart after adding downloadable products.

Fields

Example

{"cart": Cart}

AddGiftRegistryRegistrantInput

Defines a new registrant.

Input Fields

Example

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

AddGiftRegistryRegistrantsOutput

Contains the results of a request to add registrants.

Fields

Example

{"gift_registry": GiftRegistry}

AddProductsToCartOutput

Contains details about the cart after adding products to it.

Fields

Example

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

AddProductsToCompareListInput

Contains products to add to an existing compare list.

Input Fields

Example

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

AddProductsToNewCartOutput

Contains details about the cart after adding products to it.

Fields

Example

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

AddProductsToRequisitionListOutput

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

Fields

Example

{"requisition_list": RequisitionList}

AddProductsToWishlistOutput

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

Fields

Example

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

AddPurchaseOrderCommentInput

Contains the comment to be added to a purchase order.

Input Fields

Example

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

AddPurchaseOrderCommentOutput

Contains the successfully added comment.

Fields

Example

{"comment": PurchaseOrderComment}

AddPurchaseOrderItemsToCartInput

Defines the purchase order and cart to act on.

Input Fields

Example

{
  "cart_id": "xyz789",
  "purchase_order_uid": 4,
  "replace_existing_cart_items": false
}

AddRequisitionListItemToCartUserError

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

Fields

Example

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

AddRequisitionListItemToCartUserErrorType

Values

Example

""OUT_OF_STOCK""

AddRequisitionListItemsToCartOutput

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

Fields

Example

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

AddReturnCommentInput

Defines a return comment.

Input Fields

Example

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

AddReturnCommentOutput

Contains details about the return request.

Fields

Example

{"return": Return}

AddReturnTrackingInput

Defines tracking information to be added to the return.

Input Fields

Example

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

AddReturnTrackingOutput

Contains the response after adding tracking information.

Fields

Example

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

AddSimpleProductsToCartInput

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

Input Fields

Example

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

AddSimpleProductsToCartOutput

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

Fields

Example

{"cart": Cart}

AddVirtualProductsToCartInput

Defines the virtual products to add to the cart.

Input Fields

Example

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

AddVirtualProductsToCartOutput

Contains details about the cart after adding virtual products.

Fields

Example

{"cart": Cart}

AddWishlistItemsToCartOutput

Contains the resultant wish list and any error information.

Fields

Example

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

Aggregation

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

Fields

Example

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

AggregationOption

An implementation of AggregationOptionInterface.

Fields

Example

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

AggregationOptionInterface

Defines aggregation option fields.

Fields

Possible Types

Example

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

AggregationsCategoryFilterInput

Filter category aggregations in layered navigation.

Input Fields

Example

{"includeDirectChildrenOnly": false}

AggregationsFilterInput

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

Input Fields

Example

{"category": AggregationsCategoryFilterInput}

ApplePayConfig

Fields

Example

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

ApplePayMethodInput

Apple Pay inputs

Input Fields

Example

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

AppliedCoupon

Contains the applied coupon code.

Fields

Example

{"code": "xyz789"}

AppliedGiftCard

Contains an applied gift card with applied and remaining balance.

Fields

Example

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

AppliedStoreCredit

Contains the applied and current balances.

Fields

Example

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

ApplyCouponToCartInput

Specifies the coupon code to apply to the cart.

Input Fields

Example

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

ApplyCouponToCartOutput

Contains details about the cart after applying a coupon.

Fields

Example

{"cart": Cart}

ApplyCouponsStrategy

The strategy to apply coupons to the cart.

Values

Example

""APPEND""

ApplyCouponsToCartInput

Apply coupons to the cart.

Input Fields

Example

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

ApplyGiftCardToCartInput

Defines the input required to run the applyGiftCardToCart mutation.

Input Fields

Example

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

ApplyGiftCardToCartOutput

Defines the possible output for the applyGiftCardToCart mutation.

Fields

Example

{"cart": Cart}

ApplyGiftCardToOrder

Contains applied gift cards with gift card code and amount.

Fields

Example

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

ApplyRewardPointsToCartOutput

Contains the customer cart.

Fields

Example

{"cart": Cart}

ApplyStoreCreditToCartInput

Defines the input required to run the applyStoreCreditToCart mutation.

Input Fields

Example

{"cart_id": "xyz789"}

ApplyStoreCreditToCartOutput

Defines the possible output for the applyStoreCreditToCart mutation.

Fields

Example

{"cart": Cart}

AreaInput

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

Input Fields

Example

{"radius": 987, "search_term": "xyz789"}

AssignCompareListToCustomerOutput

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

Fields

Example

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

Attribute

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

Fields

Example

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

AttributeEntityTypeEnum

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

Values

Example

""CATALOG_PRODUCT""

AttributeFilterInput

An input object that specifies the filters used for attributes.

Input Fields

Example

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

AttributeFrontendInputEnum

EAV attribute frontend input types.

Values

Example

""BOOLEAN""

AttributeInput

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

Input Fields

Example

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

AttributeInputSelectedOption

Specifies selected option for a select or multiselect attribute value.

Input Fields

Example

{"value": "xyz789"}

AttributeMetadata

Base EAV implementation of CustomAttributeMetadataInterface.

Fields

Example

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

AttributeMetadataError

Attribute metadata retrieval error.

Fields

Example

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

AttributeMetadataErrorType

Attribute metadata retrieval error types.

Values

Example

""ENTITY_NOT_FOUND""

AttributeOption

Defines an attribute option.

Fields

Example

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

AttributeOptionMetadata

Base EAV implementation of CustomAttributeOptionInterface.

Fields

Example

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

AttributeSelectedOption

Fields

Example

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

AttributeSelectedOptionInterface

Fields

Possible Types

Example

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

AttributeSelectedOptions

Fields

Example

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

AttributeValue

Fields

Example

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

AttributeValueInput

Specifies the value for attribute.

Input Fields

Example

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

AttributeValueInterface

Fields

Possible Types

Example

{"code": "4"}

AttributesFormOutput

Metadata of EAV attributes associated to form

Fields

Example

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

AttributesMetadataOutput

Metadata of EAV attributes.

Fields

Example

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

AvailableCurrency

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

Fields

Example

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

AvailablePaymentMethod

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

Fields

Example

{
  "code": "xyz789",
  "is_deferred": false,
  "title": "abc123"
}

AvailableShippingMethod

Contains details about the possible shipping methods and carriers.

Fields

Example

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

BatchMutationStatus

Values

Example

""SUCCESS""

BillingAddressInput

Defines the billing address.

Input Fields

Example

{
  "address": CartAddressInput,
  "customer_address_id": 987,
  "customer_address_uid": 4,
  "same_as_shipping": false,
  "use_for_shipping": true
}

BillingAddressPaymentSourceInput

The billing address information

Input Fields

Example

{
  "address_line_1": "abc123",
  "address_line_2": "xyz789",
  "city": "abc123",
  "country_code": "abc123",
  "postal_code": "abc123",
  "region": "abc123"
}

BillingCartAddress

Contains details about the billing address.

Fields

Example

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

Boolean

The Boolean scalar type represents true or false.

Example

true

BraintreeCcVaultInput

Input Fields

Example

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

BraintreeInput

Input Fields

Example

{
  "device_data": "xyz789",
  "is_active_payment_token_enabler": true,
  "payment_method_nonce": "abc123"
}

BraintreeVaultInput

Input Fields

Example

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

Breadcrumb

Contains details about an individual category that comprises a breadcrumb.

Fields

Example

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

BundleCartItem

An implementation for bundle product cart items.

Fields

Example

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

BundleCreditMemoItem

Defines bundle product options for CreditMemoItemInterface.

Fields

Example

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

BundleInvoiceItem

Defines bundle product options for InvoiceItemInterface.

Fields

Example

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

BundleItem

Defines an individual item within a bundle product.

Fields

Example

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

BundleItemOption

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

Fields

Example

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

BundleOptionInput

Defines the input for a bundle option.

Input Fields

Example

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

BundleOrderItem

Defines bundle product options for OrderItemInterface.

Fields

Example

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

BundleProduct

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

Fields

Example

{
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "dynamic_price": false,
  "dynamic_sku": true,
  "dynamic_weight": true,
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [BundleItem],
  "manufacturer": 987,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "xyz789",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "price": ProductPrices,
  "price_details": PriceDetails,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "price_view": "PRICE_RANGE",
  "product_links": [ProductLinksInterface],
  "quantity": 987.65,
  "rating_summary": 987.65,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "xyz789",
  "review_count": 987,
  "reviews": ProductReviews,
  "ship_bundle_items": "TOGETHER",
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 987.65,
  "special_to_date": "xyz789",
  "staged": false,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "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": "xyz789",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "websites": [Website],
  "weight": 987.65
}

BundleProductCartItemInput

Defines a single bundle product.

Input Fields

Example

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

BundleRequisitionListItem

Contains details about bundle products added to a requisition list.

Fields

Example

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

BundleShipmentItem

Defines bundle product options for ShipmentItemInterface.

Fields

Example

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

BundleWishlistItem

Defines bundle product options for WishlistItemInterface.

Fields

Example

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

ButtonStyles

Fields

Example

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

CancelNegotiableQuoteTemplateInput

Specifies the quote template id of the quote template to cancel

Input Fields

Example

{
  "cancellation_comment": "xyz789",
  "template_id": "4"
}

CancelOrderError

Fields

Example

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

CancelOrderErrorCode

Values

Example

""ORDER_CANCELLATION_DISABLED""

CancelOrderInput

Defines the order to cancel.

Input Fields

Example

{"order_id": 4, "reason": "xyz789"}

CancelOrderOutput

Contains the updated customer order and error message if any.

Fields

Example

{
  "error": "abc123",
  "errorV2": CancelOrderError,
  "order": CustomerOrder
}

CancellationReason

Fields

Example

{"description": "xyz789"}

Card

Fields

Example

{
  "bin_details": CardBin,
  "card_expiry_month": "xyz789",
  "card_expiry_year": "abc123",
  "last_digits": "xyz789",
  "name": "xyz789"
}

CardBin

Fields

Example

{"bin": "xyz789"}

CardPaymentSourceInput

The card payment source information

Input Fields

Example

{
  "billing_address": BillingAddressPaymentSourceInput,
  "name": "abc123"
}

CardPaymentSourceOutput

The card payment source information

Fields

Example

{
  "brand": "abc123",
  "expiry": "abc123",
  "last_digits": "abc123"
}

Cart

Contains the contents and other details about a guest or customer cart.

Fields

Example

{
  "applied_coupon": AppliedCoupon,
  "applied_coupons": [AppliedCoupon],
  "applied_gift_cards": [AppliedGiftCard],
  "applied_reward_points": RewardPointsAmount,
  "applied_store_credit": AppliedStoreCredit,
  "available_gift_wrappings": [GiftWrapping],
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": BillingCartAddress,
  "email": "xyz789",
  "gift_message": GiftMessage,
  "gift_receipt_included": true,
  "gift_wrapping": GiftWrapping,
  "id": 4,
  "is_virtual": false,
  "items": [CartItemInterface],
  "itemsV2": CartItems,
  "prices": CartPrices,
  "printed_card_included": false,
  "rules": [CartRuleStorefront],
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [ShippingCartAddress],
  "total_quantity": 123.45
}

CartAddressCountry

Contains details the country in a billing or shipping address.

Fields

Example

{
  "code": "abc123",
  "label": "abc123"
}

CartAddressInput

Defines the billing or shipping address to be applied to the cart.

Input Fields

Example

{
  "city": "xyz789",
  "company": "xyz789",
  "country_code": "abc123",
  "custom_attributes": [AttributeValueInput],
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "abc123",
  "region": "xyz789",
  "region_id": 123,
  "save_in_address_book": false,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "abc123",
  "vat_id": "abc123"
}

CartAddressInterface

Fields

Possible Types

Example

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

CartAddressRegion

Contains details about the region in a billing or shipping address.

Fields

Example

{
  "code": "abc123",
  "label": "xyz789",
  "region_id": 987
}

CartDiscount

Contains information about discounts applied to the cart.

Fields

Example

{
  "amount": Money,
  "label": ["xyz789"]
}

CartDiscountType

Values

Example

""ITEM""

CartItemError

Fields

Example

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

CartItemErrorType

Values

Example

""UNDEFINED""

CartItemInput

Defines an item to be added to the cart.

Input Fields

Example

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

CartItemInterface

An interface for products in a cart.

Fields

Possible Types

Example

{
  "discount": [Discount],
  "errors": [CartItemError],
  "id": "abc123",
  "is_available": true,
  "max_qty": 987.65,
  "min_qty": 987.65,
  "not_available_message": "abc123",
  "note_from_buyer": [ItemNote],
  "note_from_seller": [ItemNote],
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 987.65,
  "uid": "4"
}

CartItemPrices

Contains details about the price of the item, including taxes and discounts.

Fields

Example

{
  "catalog_discount": ProductDiscount,
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "original_item_price": Money,
  "original_row_total": Money,
  "price": Money,
  "price_including_tax": Money,
  "row_catalog_discount": ProductDiscount,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

CartItemQuantity

Deprecated: The ShippingCartAddress.cart_items field now returns CartItemInterface.

Fields

Example

{"cart_item_id": 987, "quantity": 987.65}

CartItemSelectedOptionValuePrice

Contains details about the price of a selected customizable value.

Fields

Example

{
  "type": "FIXED",
  "units": "abc123",
  "value": 123.45
}

CartItemUpdateInput

A single item to be updated.

Input Fields

Example

{
  "cart_item_id": 123,
  "cart_item_uid": 4,
  "customizable_options": [CustomizableOptionInput],
  "gift_message": GiftMessageInput,
  "gift_wrapping_id": 4,
  "quantity": 987.65
}

CartItems

Fields

Example

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

CartPrices

Contains details about the final price of items in the cart, including discount and tax information.

Fields

Example

{
  "applied_taxes": [CartTaxItem],
  "discount": CartDiscount,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excluding_tax": Money,
  "subtotal_excluding_tax": Money,
  "subtotal_including_tax": Money,
  "subtotal_with_discount_excluding_tax": Money
}

CartRuleStorefront

Fields

Example

{"uid": "4"}

CartTaxItem

Contains tax information about an item in the cart.

Fields

Example

{
  "amount": Money,
  "label": "abc123"
}

CartUserInputError

Fields

Example

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

CartUserInputErrorType

Values

Example

""PRODUCT_NOT_FOUND""

CatalogAttributeApplyToEnum

Values

Example

""SIMPLE""

CatalogAttributeMetadata

Swatch attribute metadata.

Fields

Example

{
  "apply_to": ["SIMPLE"],
  "code": 4,
  "default_value": "xyz789",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "abc123",
  "frontend_input": "BOOLEAN",
  "is_comparable": true,
  "is_filterable": true,
  "is_filterable_in_search": false,
  "is_html_allowed_on_front": true,
  "is_required": true,
  "is_searchable": false,
  "is_unique": false,
  "is_used_for_price_rules": true,
  "is_used_for_promo_rules": true,
  "is_visible_in_advanced_search": false,
  "is_visible_on_front": false,
  "is_wysiwyg_enabled": false,
  "label": "abc123",
  "options": [CustomAttributeOptionInterface],
  "swatch_input_type": "BOOLEAN",
  "update_product_preview_image": false,
  "use_product_image_for_swatch": true,
  "used_in_product_listing": false
}

CategoryFilterInput

Defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

Input Fields

Example

{
  "category_uid": FilterEqualTypeInput,
  "ids": FilterEqualTypeInput,
  "name": FilterMatchTypeInput,
  "parent_category_uid": FilterEqualTypeInput,
  "parent_id": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput,
  "url_path": FilterEqualTypeInput
}

CategoryInterface

Contains the full set of attributes that can be returned in a category search.

Fields

Possible Types

Example

{
  "automatic_sorting": "abc123",
  "available_sort_by": ["xyz789"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "xyz789",
  "children_count": "xyz789",
  "cms_block": CmsBlock,
  "created_at": "xyz789",
  "custom_layout_update_file": "abc123",
  "default_sort_by": "abc123",
  "description": "xyz789",
  "display_mode": "xyz789",
  "filter_price_range": 987.65,
  "id": 123,
  "image": "abc123",
  "include_in_menu": 123,
  "is_anchor": 987,
  "landing_page": 987,
  "level": 987,
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "xyz789",
  "name": "xyz789",
  "path": "abc123",
  "path_in_store": "abc123",
  "position": 987,
  "product_count": 123,
  "products": CategoryProducts,
  "staged": false,
  "uid": "4",
  "updated_at": "xyz789",
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_suffix": "xyz789"
}

CategoryProducts

Contains details about the products assigned to a category.

Fields

Example

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

CategoryResult

Contains a collection of CategoryTree objects and pagination information.

Fields

Example

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

CategoryTree

Contains the hierarchy of categories.

Fields

Example

{
  "automatic_sorting": "xyz789",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "abc123",
  "children": [CategoryTree],
  "children_count": "abc123",
  "cms_block": CmsBlock,
  "created_at": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "xyz789",
  "description": "xyz789",
  "display_mode": "abc123",
  "filter_price_range": 123.45,
  "id": 987,
  "image": "xyz789",
  "include_in_menu": 123,
  "is_anchor": 987,
  "landing_page": 123,
  "level": 987,
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "abc123",
  "name": "xyz789",
  "path": "abc123",
  "path_in_store": "abc123",
  "position": 987,
  "product_count": 987,
  "products": CategoryProducts,
  "redirect_code": 987,
  "relative_url": "xyz789",
  "staged": false,
  "type": "CMS_PAGE",
  "uid": "4",
  "updated_at": "xyz789",
  "url_key": "xyz789",
  "url_path": "xyz789",
  "url_suffix": "xyz789"
}

CheckoutAgreement

Defines details about an individual checkout agreement.

Fields

Example

{
  "agreement_id": 123,
  "checkbox_text": "xyz789",
  "content": "xyz789",
  "content_height": "abc123",
  "is_html": false,
  "mode": "AUTO",
  "name": "xyz789"
}

CheckoutAgreementMode

Indicates how agreements are accepted.

Values

Example

""AUTO""

CheckoutUserInputError

An error encountered while adding an item to the cart.

Fields

Example

{
  "code": "REORDER_NOT_AVAILABLE",
  "message": "xyz789",
  "path": ["abc123"]
}

CheckoutUserInputErrorCodes

Values

Example

""REORDER_NOT_AVAILABLE""

ClearCartError

Contains details about errors encountered when a customer clear cart.

Fields

Example

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

ClearCartErrorType

Values

Example

""NOT_FOUND""

ClearCartInput

Assigns a specific cart_id to the empty cart.

Input Fields

Example

{"uid": "4"}

ClearCartOutput

Output of the request to clear the customer cart.

Fields

Example

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

ClearCustomerCartOutput

Output of the request to clear the customer cart.

Fields

Example

{"cart": Cart, "status": false}

CloseNegotiableQuoteError

Types

Example

NegotiableQuoteInvalidStateError

CloseNegotiableQuoteOperationFailure

Contains details about a failed close operation on a negotiable quote.

Fields

Example

{
  "errors": [NegotiableQuoteInvalidStateError],
  "quote_uid": 4
}

CloseNegotiableQuoteOperationResult

Types

Example

NegotiableQuoteUidOperationSuccess

CloseNegotiableQuotesInput

Defines the negotiable quotes to mark as closed.

Input Fields

Example

{"quote_uids": [4]}

CloseNegotiableQuotesOutput

Contains the closed negotiable quotes and other negotiable quotes the company user can view.

Fields

Example

{
  "closed_quotes": [NegotiableQuote],
  "negotiable_quotes": NegotiableQuotesOutput,
  "operation_results": [
    NegotiableQuoteUidOperationSuccess
  ],
  "result_status": "SUCCESS"
}

CmsBlock

Contains details about a specific CMS block.

Fields

Example

{
  "content": "abc123",
  "identifier": "abc123",
  "title": "abc123"
}

CmsBlocks

Contains an array CMS block items.

Fields

Example

{"items": [CmsBlock]}

CmsPage

Contains details about a CMS page.

Fields

Example

{
  "content": "xyz789",
  "content_heading": "xyz789",
  "identifier": "abc123",
  "meta_description": "abc123",
  "meta_keywords": "abc123",
  "meta_title": "xyz789",
  "page_layout": "xyz789",
  "redirect_code": 987,
  "relative_url": "abc123",
  "title": "abc123",
  "type": "CMS_PAGE",
  "url_key": "xyz789"
}

ColorSwatchData

Fields

Example

{"value": "xyz789"}

CompaniesSortFieldEnum

The fields available for sorting the customer companies.

Values

Example

""NAME""

CompaniesSortInput

Specifies which field to sort on, and whether to return the results in ascending or descending order.

Input Fields

Example

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

Company

Contains the output schema for a company.

Fields

Example

{
  "acl_resources": [CompanyAclResource],
  "company_admin": Customer,
  "credit": CompanyCredit,
  "credit_history": CompanyCreditHistory,
  "email": "xyz789",
  "id": "4",
  "legal_address": CompanyLegalAddress,
  "legal_name": "xyz789",
  "name": "abc123",
  "payment_methods": ["xyz789"],
  "reseller_id": "abc123",
  "role": CompanyRole,
  "roles": CompanyRoles,
  "sales_representative": CompanySalesRepresentative,
  "structure": CompanyStructure,
  "team": CompanyTeam,
  "user": Customer,
  "users": CompanyUsers,
  "vat_tax_id": "xyz789"
}

CompanyAclResource

Contains details about the access control list settings of a resource.

Fields

Example

{
  "children": [CompanyAclResource],
  "id": 4,
  "sort_order": 123,
  "text": "abc123"
}

CompanyAdminInput

Defines the input schema for creating a company administrator.

Input Fields

Example

{
  "custom_attributes": [AttributeValueInput],
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 987,
  "job_title": "abc123",
  "lastname": "xyz789",
  "telephone": "xyz789"
}

CompanyBasicInfo

The minimal required information to identify and display the company.

Fields

Example

{
  "id": 4,
  "legal_name": "xyz789",
  "name": "abc123",
  "status": "PENDING"
}

CompanyCreateInput

Defines the input schema for creating a new company.

Input Fields

Example

{
  "company_admin": CompanyAdminInput,
  "company_email": "abc123",
  "company_name": "xyz789",
  "legal_address": CompanyLegalAddressCreateInput,
  "legal_name": "xyz789",
  "reseller_id": "abc123",
  "vat_tax_id": "abc123"
}

CompanyCredit

Contains company credit balances and limits.

Fields

Example

{
  "available_credit": Money,
  "credit_limit": Money,
  "outstanding_balance": Money
}

CompanyCreditHistory

Contains details about prior company credit operations.

Fields

Example

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

CompanyCreditHistoryFilterInput

Defines a filter for narrowing the results of a credit history search.

Input Fields

Example

{
  "custom_reference_number": "xyz789",
  "operation_type": "ALLOCATION",
  "updated_by": "xyz789"
}

CompanyCreditOperation

Contains details about a single company credit operation.

Fields

Example

{
  "amount": Money,
  "balance": CompanyCredit,
  "custom_reference_number": "xyz789",
  "date": "xyz789",
  "type": "ALLOCATION",
  "updated_by": CompanyCreditOperationUser
}

CompanyCreditOperationType

Values

Example

""ALLOCATION""

CompanyCreditOperationUser

Defines the administrator or company user that submitted a company credit operation.

Fields

Example

{"name": "abc123", "type": "CUSTOMER"}

CompanyCreditOperationUserType

Values

Example

""CUSTOMER""

CompanyInvitationInput

Defines the input schema for accepting the company invitation.

Input Fields

Example

{
  "code": "xyz789",
  "role_id": 4,
  "user": CompanyInvitationUserInput
}

CompanyInvitationOutput

The result of accepting the company invitation.

Fields

Example

{"success": false}

CompanyInvitationUserInput

Company user attributes in the invitation.

Input Fields

Example

{
  "company_id": "4",
  "customer_id": 4,
  "job_title": "xyz789",
  "status": "ACTIVE",
  "telephone": "xyz789"
}

CompanyLegalAddress

Contains details about the address where the company is registered to conduct business.

Fields

Example

{
  "city": "abc123",
  "country_code": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123"
}

CompanyLegalAddressCreateInput

Defines the input schema for defining a company's legal address.

Input Fields

Example

{
  "city": "abc123",
  "country_id": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["xyz789"],
  "telephone": "abc123"
}

CompanyLegalAddressUpdateInput

Defines the input schema for updating a company's legal address.

Input Fields

Example

{
  "city": "xyz789",
  "country_id": "AF",
  "postcode": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["xyz789"],
  "telephone": "abc123"
}

CompanyRole

Contails details about a single role.

Fields

Example

{
  "id": "4",
  "name": "abc123",
  "permissions": [CompanyAclResource],
  "users_count": 123
}

CompanyRoleCreateInput

Defines the input schema for creating a company role.

Input Fields

Example

{
  "name": "xyz789",
  "permissions": ["abc123"]
}

CompanyRoleUpdateInput

Defines the input schema for updating a company role.

Input Fields

Example

{
  "id": 4,
  "name": "xyz789",
  "permissions": ["abc123"]
}

CompanyRoles

Contains an array of roles.

Fields

Example

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

CompanySalesRepresentative

Contains details about a company sales representative.

Fields

Example

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

CompanyStatusEnum

Defines the list of company status values.

Values

Example

""PENDING""

CompanyStructure

Contains an array of the individual nodes that comprise the company structure.

Fields

Example

{"items": [CompanyStructureItem]}

CompanyStructureEntity

Types

Example

CompanyTeam

CompanyStructureItem

Defines an individual node in the company structure.

Fields

Example

{
  "entity": CompanyTeam,
  "id": "4",
  "parent_id": "4"
}

CompanyStructureUpdateInput

Defines the input schema for updating the company structure.

Input Fields

Example

{
  "parent_tree_id": "4",
  "tree_id": "4"
}

CompanyTeam

Describes a company team.

Fields

Example

{
  "description": "abc123",
  "id": "4",
  "name": "xyz789",
  "structure_id": "4"
}

CompanyTeamCreateInput

Defines the input schema for creating a company team.

Input Fields

Example

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

CompanyTeamUpdateInput

Defines the input schema for updating a company team.

Input Fields

Example

{
  "description": "abc123",
  "id": "4",
  "name": "abc123"
}

CompanyUpdateInput

Defines the input schema for updating a company.

Input Fields

Example

{
  "company_email": "xyz789",
  "company_name": "abc123",
  "legal_address": CompanyLegalAddressUpdateInput,
  "legal_name": "xyz789",
  "reseller_id": "xyz789",
  "vat_tax_id": "abc123"
}

CompanyUserCreateInput

Defines the input schema for creating a company user.

Input Fields

Example

{
  "email": "xyz789",
  "firstname": "xyz789",
  "job_title": "abc123",
  "lastname": "abc123",
  "role_id": "4",
  "status": "ACTIVE",
  "target_id": 4,
  "telephone": "xyz789"
}

CompanyUserStatusEnum

Defines the list of company user status values.

Values

Example

""ACTIVE""

CompanyUserUpdateInput

Defines the input schema for updating a company user.

Input Fields

Example

{
  "email": "abc123",
  "firstname": "abc123",
  "id": 4,
  "job_title": "abc123",
  "lastname": "abc123",
  "role_id": "4",
  "status": "ACTIVE",
  "telephone": "xyz789"
}

CompanyUsers

Contains details about company users.

Fields

Example

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

CompanyUsersFilterInput

Defines the filter for returning a list of company users.

Input Fields

Example

{"status": "ACTIVE"}

ComparableAttribute

Contains an attribute code that is used for product comparisons.

Fields

Example

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

ComparableItem

Defines an object used to iterate through items for product comparisons.

Fields

Example

{
  "attributes": [ProductAttribute],
  "product": ProductInterface,
  "uid": 4
}

CompareList

Contains iterable information such as the array of items, the count, and attributes that represent the compare list.

Fields

Example

{
  "attributes": [ComparableAttribute],
  "item_count": 987,
  "items": [ComparableItem],
  "uid": 4
}

CompleteOrderInput

Update the quote and complete the order

Input Fields

Example

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

ComplexTextValue

Fields

Example

{"html": "xyz789"}

ConfigurableAttributeOption

Contains details about a configurable product attribute option.

Fields

Example

{
  "code": "xyz789",
  "label": "abc123",
  "uid": "4",
  "value_index": 123
}

ConfigurableCartItem

An implementation for configurable product cart items.

Fields

Example

{
  "available_gift_wrapping": [GiftWrapping],
  "configurable_options": [SelectedConfigurableOption],
  "configured_variant": ProductInterface,
  "customizable_options": [SelectedCustomizableOption],
  "discount": [Discount],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "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": 987.65,
  "uid": "4"
}

ConfigurableOptionAvailableForSelection

Describes configurable options that have been selected and can be selected as a result of the previous selections.

Fields

Example

{
  "attribute_code": "xyz789",
  "option_value_uids": ["4"]
}

ConfigurableOrderItem

Fields

Example

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

ConfigurableProduct

Defines basic features of a configurable product and its simple product variants.

Fields

Example

{
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "color": 987,
  "configurable_options": [ConfigurableProductOptions],
  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": true,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "id": 123,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 123,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "xyz789",
  "meta_title": "xyz789",
  "min_sale_qty": 987.65,
  "name": "abc123",
  "new_from_date": "abc123",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "xyz789",
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 987.65,
  "rating_summary": 987.65,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 987,
  "reviews": ProductReviews,
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "swatch_image": "xyz789",
  "thumbnail": ProductImage,
  "tier_price": 987.65,
  "tier_prices": [ProductTierPrices],
  "type": "CMS_PAGE",
  "type_id": "xyz789",
  "uid": "4",
  "updated_at": "xyz789",
  "upsell_products": [ProductInterface],
  "url_key": "xyz789",
  "url_path": "abc123",
  "url_rewrites": [UrlRewrite],
  "url_suffix": "abc123",
  "variants": [ConfigurableVariant],
  "websites": [Website],
  "weight": 987.65
}

ConfigurableProductCartItemInput

Input Fields

Example

{
  "customizable_options": [CustomizableOptionInput],
  "data": CartItemInput,
  "parent_sku": "xyz789",
  "variant_sku": "xyz789"
}

ConfigurableProductOption

Contains details about configurable product options.

Fields

Example

{
  "attribute_code": "xyz789",
  "label": "xyz789",
  "uid": "4",
  "values": [ConfigurableProductOptionValue]
}

ConfigurableProductOptionValue

Defines a value for a configurable product option.

Fields

Example

{
  "is_available": false,
  "is_use_default": true,
  "label": "xyz789",
  "swatch": SwatchDataInterface,
  "uid": "4"
}

ConfigurableProductOptions

Defines configurable attributes for the specified product.

Fields

Example

{
  "attribute_code": "xyz789",
  "attribute_id": "abc123",
  "attribute_id_v2": 123,
  "attribute_uid": 4,
  "id": 123,
  "label": "abc123",
  "position": 987,
  "product_id": 123,
  "uid": 4,
  "use_default": true,
  "values": [ConfigurableProductOptionsValues]
}

ConfigurableProductOptionsSelection

Contains metadata corresponding to the selected configurable options.

Fields

Example

{
  "configurable_options": [ConfigurableProductOption],
  "media_gallery": [MediaGalleryInterface],
  "options_available_for_selection": [
    ConfigurableOptionAvailableForSelection
  ],
  "variant": SimpleProduct
}

ConfigurableProductOptionsValues

Contains the index number assigned to a configurable product option.

Fields

Example

{
  "default_label": "abc123",
  "label": "xyz789",
  "store_label": "xyz789",
  "swatch_data": SwatchDataInterface,
  "uid": "4",
  "use_default_value": false,
  "value_index": 987
}

ConfigurableRequisitionListItem

Contains details about configurable products added to a requisition list.

Fields

Example

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

ConfigurableVariant

Contains all the simple product variants of a configurable product.

Fields

Example

{
  "attributes": [ConfigurableAttributeOption],
  "product": SimpleProduct
}

ConfigurableWishlistItem

A configurable product wish list item.

Fields

Example

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

ConfirmCancelOrderInput

Input Fields

Example

{
  "confirmation_key": "abc123",
  "order_id": 4
}

ConfirmEmailInput

Contains details about a customer email address to confirm.

Input Fields

Example

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

ConfirmReturnInput

Input Fields

Example

{
  "confirmation_key": "xyz789",
  "order_id": 4
}

ConfirmationStatusEnum

List of account confirmation statuses.

Values

Example

""ACCOUNT_CONFIRMED""

ContactUsInput

Input Fields

Example

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

ContactUsOutput

Contains the status of the request.

Fields

Example

{"status": false}

CopyItemsBetweenRequisitionListsInput

An input object that defines the items in a requisition list to be copied.

Input Fields

Example

{"requisitionListItemUids": [4]}

CopyItemsFromRequisitionListsOutput

Output of the request to copy items to the destination requisition list.

Fields

Example

{"requisition_list": RequisitionList}

CopyProductsBetweenWishlistsOutput

Contains the source and target wish lists after copying products.

Fields

Example

{
  "destination_wishlist": Wishlist,
  "source_wishlist": Wishlist,
  "user_errors": [WishListUserInputError]
}

Country

Fields

Example

{
  "available_regions": [Region],
  "full_name_english": "abc123",
  "full_name_locale": "xyz789",
  "id": "xyz789",
  "three_letter_abbreviation": "abc123",
  "two_letter_abbreviation": "xyz789"
}

CountryCodeEnum

The list of country codes.

Values

Example

""AF""

CreateCompanyOutput

Contains the response to the request to create a company.

Fields

Example

{"company": Company}

CreateCompanyRoleOutput

Contains the response to the request to create a company role.

Fields

Example

{"role": CompanyRole}

CreateCompanyTeamOutput

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

Fields

Example

{"team": CompanyTeam}

CreateCompanyUserOutput

Contains the response to the request to create a company user.

Fields

Example

{"user": Customer}

CreateCompareListInput

Contains an array of product IDs to use for creating a compare list.

Input Fields

Example

{"products": ["4"]}

CreateGiftRegistryInput

Defines a new gift registry.

Input Fields

Example

{
  "dynamic_attributes": [
    GiftRegistryDynamicAttributeInput
  ],
  "event_name": "abc123",
  "gift_registry_type_uid": "4",
  "message": "xyz789",
  "privacy_settings": "PRIVATE",
  "registrants": [AddGiftRegistryRegistrantInput],
  "shipping_address": GiftRegistryShippingAddressInput,
  "status": "ACTIVE"
}

CreateGiftRegistryOutput

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

Fields

Example

{"gift_registry": GiftRegistry}

CreateGuestCartInput

Input Fields

Example

{"cart_uid": 4}

CreateGuestCartOutput

Fields

Example

{"cart": Cart}

CreatePayflowProTokenOutput

Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods.

Fields

Example

{
  "response_message": "abc123",
  "result": 123,
  "result_code": 987,
  "secure_token": "xyz789",
  "secure_token_id": "abc123"
}

CreatePaymentOrderInput

Contains payment order details that are used while processing the payment order

Input Fields

Example

{
  "cartId": "xyz789",
  "location": "PRODUCT_DETAIL",
  "methodCode": "xyz789",
  "paymentSource": "abc123",
  "vaultIntent": false
}

CreatePaymentOrderOutput

Contains payment order details that are used while processing the payment order

Fields

Example

{
  "amount": 123.45,
  "currency_code": "abc123",
  "id": "xyz789",
  "mp_order_id": "abc123",
  "status": "abc123"
}

CreateProductReviewInput

Defines a new product review.

Input Fields

Example

{
  "nickname": "xyz789",
  "ratings": [ProductReviewRatingInput],
  "sku": "abc123",
  "summary": "xyz789",
  "text": "abc123"
}

CreateProductReviewOutput

Contains the completed product review.

Fields

Example

{"review": ProductReview}

CreatePurchaseOrderApprovalRuleConditionAmountInput

Specifies the amount and currency to evaluate.

Input Fields

Example

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

CreatePurchaseOrderApprovalRuleConditionInput

Defines a set of conditions that apply to a rule.

Input Fields

Example

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

CreateRequisitionListInput

An input object that identifies and describes a new requisition list.

Input Fields

Example

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

CreateRequisitionListOutput

Output of the request to create a requisition list.

Fields

Example

{"requisition_list": RequisitionList}

CreateVaultCardPaymentTokenInput

Describe the variables needed to create a vault payment token

Input Fields

Example

{
  "card_description": "xyz789",
  "setup_token_id": "abc123"
}

CreateVaultCardPaymentTokenOutput

The vault token id and information about the payment source

Fields

Example

{
  "payment_source": PaymentSourceOutput,
  "vault_token_id": "xyz789"
}

CreateVaultCardSetupTokenInput

Describe the variables needed to create a vault card setup token

Input Fields

Example

{
  "setup_token": VaultSetupTokenInput,
  "three_ds_mode": "OFF"
}

CreateVaultCardSetupTokenOutput

The setup token id information

Fields

Example

{"setup_token": "abc123"}

CreateWishlistInput

Defines the name and visibility of a new wish list.

Input Fields

Example

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

CreateWishlistOutput

Contains the wish list.

Fields

Example

{"wishlist": Wishlist}

CreditCardDetailsInput

Required fields for Payflow Pro and Payments Pro credit card payments.

Input Fields

Example

{
  "cc_exp_month": 987,
  "cc_exp_year": 123,
  "cc_last_4": 123,
  "cc_type": "abc123"
}

CreditMemo

Contains credit memo details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [CreditMemoItemInterface],
  "number": "xyz789",
  "total": CreditMemoTotal
}

CreditMemoItem

Fields

Example

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

CreditMemoItemInterface

Credit memo item details.

Fields

Possible Types

Example

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

CreditMemoTotal

Contains credit memo price details.

Fields

Example

{
  "adjustment": Money,
  "base_grand_total": Money,
  "discounts": [Discount],
  "grand_total": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "taxes": [TaxItem],
  "total_shipping": Money,
  "total_tax": Money
}