Types

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": "abc123",
  "cart_items": [DownloadableProductCartItemInput]
}

AddDownloadableProductsToCartOutput

Contains details about the cart after adding downloadable products.

Fields

Example

{"cart": Cart}

AddGiftRegistryRegistrantInput

Defines a new registrant.

Input Fields

Example

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

AddGiftRegistryRegistrantsOutput

Contains the results of a request to add registrants.

Fields

Example

{"gift_registry": GiftRegistry}

AddProductsToCartOutput

Contains details about the cart after adding products to it.

Fields

Example

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

AddProductsToCompareListInput

Contains products to add to an existing compare list.

Input Fields

Example

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

AddProductsToRequisitionListOutput

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

Fields

Example

{"requisition_list": RequisitionList}

AddProductsToWishlistOutput

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

Fields

Example

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

AddPurchaseOrderCommentInput

Contains the comment to be added to a purchase order.

Input Fields

Example

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

AddPurchaseOrderCommentOutput

Contains the successfully added comment.

Fields

Example

{"comment": PurchaseOrderComment}

AddPurchaseOrderItemsToCartInput

Defines the purchase order and cart to act on.

Input Fields

Example

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

AddRequisitionListItemToCartUserError

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

Fields

Example

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

AddRequisitionListItemToCartUserErrorType

Values

Example

""OUT_OF_STOCK""

AddRequisitionListItemsToCartOutput

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

Fields

Example

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

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

AddReturnTrackingOutput

Contains the response after adding tracking information.

Fields

Example

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

AddSimpleProductsToCartInput

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

Input Fields

Example

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

AddSimpleProductsToCartOutput

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

Fields

Example

{"cart": Cart}

AddVirtualProductsToCartInput

Defines the virtual products to add to the cart.

Input Fields

Example

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

AddVirtualProductsToCartOutput

Contains details about the cart after adding virtual products.

Fields

Example

{"cart": Cart}

AddWishlistItemsToCartOutput

Contains the resultant wish list and any error information.

Fields

Example

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

Aggregation

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

Fields

Example

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

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

AggregationsCategoryFilterInput

Filter category aggregations in layered navigation.

Input Fields

Example

{"includeDirectChildrenOnly": false}

AggregationsFilterInput

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

Input Fields

Example

{"category": AggregationsCategoryFilterInput}

AppliedCoupon

Contains the applied coupon code.

Fields

Example

{"code": "abc123"}

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}

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}

ApplyRewardPointsToCartOutput

Contains the customer cart.

Fields

Example

{"cart": Cart}

ApplyStoreCreditToCartInput

Defines the input required to run the applyStoreCreditToCart mutation.

Input Fields

Example

{"cart_id": "abc123"}

ApplyStoreCreditToCartOutput

Defines the possible output for the applyStoreCreditToCart mutation.

Fields

Example

{"cart": Cart}

AreaInput

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

Input Fields

Example

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

AssignCompareListToCustomerOutput

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

Fields

Example

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

Attribute

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

Fields

Example

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

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

AttributeOption

Defines an attribute option.

Fields

Example

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

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

BatchMutationStatus

Values

Example

""SUCCESS""

BillingAddressInput

Defines the billing address.

Input Fields

Example

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

BillingCartAddress

Contains details about the billing address.

Fields

Example

{
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "customer_notes": "abc123",
  "firstname": "xyz789",
  "lastname": "xyz789",
  "postcode": "abc123",
  "region": CartAddressRegion,
  "street": ["abc123"],
  "telephone": "abc123",
  "uid": "abc123",
  "vat_id": "abc123"
}

Boolean

The Boolean scalar type represents true or false.

BraintreeCcVaultInput

Input Fields

Example

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

BraintreeInput

Input Fields

Example

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

Breadcrumb

Contains details about an individual category that comprises a breadcrumb.

Fields

Example

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

BundleCartItem

An implementation for bundle product cart items.

Fields

Example

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

BundleInvoiceItem

Defines bundle product options for InvoiceItemInterface.

Fields

Example

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

BundleItem

Defines an individual item within a bundle product.

Fields

Example

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

BundleItemOption

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

Fields

Example

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

BundleOptionInput

Defines the input for a bundle option.

Input Fields

Example

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

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",
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "abc123",
  "product_url_key": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 123.45,
  "quantity_refunded": 123.45,
  "quantity_returned": 123.45,
  "quantity_shipped": 123.45,
  "selected_options": [OrderItemOption],
  "status": "abc123"
}

BundleProduct

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

Fields

Example

{
  "activity": "xyz789",
  "attribute_set_id": 123,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "abc123",
  "collar": "abc123",
  "color": 987,
  "country_of_manufacture": "xyz789",
  "created_at": "xyz789",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "dynamic_price": false,
  "dynamic_sku": true,
  "dynamic_weight": true,
  "eco_collection": 123,
  "erin_recommends": 123,
  "features_bags": "abc123",
  "format": 123,
  "gender": "abc123",
  "gift_message_available": "abc123",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "items": [BundleItem],
  "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": "xyz789",
  "only_x_left_in_stock": 123.45,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "pattern": "xyz789",
  "performance_fabric": 987,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "price_view": "PRICE_RANGE",
  "product_links": [ProductLinksInterface],
  "purpose": 123,
  "rating_summary": 123.45,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 123,
  "reviews": ProductReviews,
  "sale": 987,
  "ship_bundle_items": "TOGETHER",
  "short_description": ComplexTextValue,
  "size": 123,
  "sku": "abc123",
  "sleeve": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 123.45,
  "special_to_date": "xyz789",
  "staged": true,
  "stock_status": "IN_STOCK",
  "strap_bags": "xyz789",
  "style_bags": "abc123",
  "style_bottom": "xyz789",
  "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": "xyz789",
  "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": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "quantity_shipped": 123.45
}

BundleWishlistItem

Defines bundle product options for WishlistItemInterface.

Fields

Example

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

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": false,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "is_virtual": true,
  "items": [CartItemInterface],
  "prices": CartPrices,
  "printed_card_included": false,
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [ShippingCartAddress],
  "total_quantity": 987.65
}

CartAddressCountry

Contains details the country in a billing or shipping address.

Fields

Example

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

CartAddressInput

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

Input Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "xyz789",
  "firstname": "abc123",
  "lastname": "abc123",
  "postcode": "abc123",
  "region": "xyz789",
  "region_id": 987,
  "save_in_address_book": false,
  "street": ["xyz789"],
  "telephone": "xyz789",
  "vat_id": "abc123"
}

CartAddressInterface

Fields

Possible Types

Example

{
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "firstname": "abc123",
  "lastname": "abc123",
  "postcode": "abc123",
  "region": CartAddressRegion,
  "street": ["xyz789"],
  "telephone": "abc123",
  "uid": "xyz789",
  "vat_id": "xyz789"
}

CartAddressRegion

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

Fields

Example

{
  "code": "xyz789",
  "label": "xyz789",
  "region_id": 123
}

CartDiscount

Contains information about discounts applied to the cart.

Fields

Example

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

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

CartItemInterface

An interface for products in a cart.

Fields

Possible Types

Example

{
  "errors": [CartItemError],
  "id": "xyz789",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "uid": 4
}

CartItemPrices

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

Fields

Example

{
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "price": Money,
  "price_including_tax": Money,
  "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": 123, "quantity": 987.65}

CartItemSelectedOptionValuePrice

Contains details about the price of a selected customizable value.

Fields

Example

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

CartItemUpdateInput

A single item to be updated.

Input Fields

Example

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

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,
  "subtotal_excluding_tax": Money,
  "subtotal_including_tax": Money,
  "subtotal_with_discount_excluding_tax": Money
}

CartTaxItem

Contains tax information about an item in the cart.

Fields

Example

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

CartUserInputError

An error encountered while adding an item to the the cart.

Fields

Example

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

CartUserInputErrorType

Values

Example

""PRODUCT_NOT_FOUND""

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": "xyz789",
  "available_sort_by": ["abc123"],
  "breadcrumbs": [Breadcrumb],
  "canonical_url": "xyz789",
  "children_count": "xyz789",
  "cms_block": CmsBlock,
  "created_at": "abc123",
  "custom_layout_update_file": "xyz789",
  "default_sort_by": "xyz789",
  "description": "xyz789",
  "display_mode": "xyz789",
  "filter_price_range": 123.45,
  "id": 987,
  "image": "xyz789",
  "include_in_menu": 123,
  "is_anchor": 987,
  "landing_page": 987,
  "level": 123,
  "meta_description": "xyz789",
  "meta_keywords": "abc123",
  "meta_title": "abc123",
  "name": "xyz789",
  "path": "xyz789",
  "path_in_store": "abc123",
  "position": 123,
  "product_count": 123,
  "products": CategoryProducts,
  "staged": true,
  "uid": 4,
  "updated_at": "abc123",
  "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": 123
}

CategoryTree

Contains the hierarchy of categories.

Fields

Example

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

CheckoutAgreement

Defines details about an individual checkout agreement.

Fields

Example

{
  "agreement_id": 987,
  "checkbox_text": "abc123",
  "content": "xyz789",
  "content_height": "xyz789",
  "is_html": true,
  "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""

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

CmsBlocks

Contains an array CMS block items.

Fields

Example

{"items": [CmsBlock]}

CmsPage

Contains details about a CMS page.

Fields

Example

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

ColorSwatchData

Fields

Example

{"value": "xyz789"}

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": "abc123",
  "name": "abc123",
  "payment_methods": ["abc123"],
  "reseller_id": "abc123",
  "role": CompanyRole,
  "roles": CompanyRoles,
  "sales_representative": CompanySalesRepresentative,
  "structure": CompanyStructure,
  "team": CompanyTeam,
  "user": Customer,
  "users": CompanyUsers,
  "vat_tax_id": "abc123"
}

CompanyAclResource

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

Fields

Example

{
  "children": [CompanyAclResource],
  "id": 4,
  "sort_order": 987,
  "text": "xyz789"
}

CompanyAdminInput

Defines the input schema for creating a company administrator.

Input Fields

Example

{
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "job_title": "abc123",
  "lastname": "abc123"
}

CompanyCreateInput

Defines the input schema for creating a new company.

Input Fields

Example

{
  "company_admin": CompanyAdminInput,
  "company_email": "xyz789",
  "company_name": "abc123",
  "legal_address": CompanyLegalAddressCreateInput,
  "legal_name": "abc123",
  "reseller_id": "xyz789",
  "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": "abc123",
  "operation_type": "ALLOCATION",
  "updated_by": "abc123"
}

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

CompanyCreditOperationUserType

Values

Example

""CUSTOMER""

CompanyLegalAddress

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

Fields

Example

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

CompanyLegalAddressCreateInput

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

Input Fields

Example

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

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

CompanyRole

Contails details about a single role.

Fields

Example

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

CompanyRoleCreateInput

Defines the input schema for creating a company role.

Input Fields

Example

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

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

CompanyTeamUpdateInput

Defines the input schema for updating a company team.

Input Fields

Example

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

CompanyUpdateInput

Defines the input schema for updating a company.

Input Fields

Example

{
  "company_email": "abc123",
  "company_name": "xyz789",
  "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": "abc123",
  "job_title": "xyz789",
  "lastname": "abc123",
  "role_id": "4",
  "status": "ACTIVE",
  "target_id": 4,
  "telephone": "abc123"
}

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": "xyz789",
  "firstname": "abc123",
  "id": 4,
  "job_title": "xyz789",
  "lastname": "xyz789",
  "role_id": 4,
  "status": "ACTIVE",
  "telephone": "abc123"
}

CompanyUsers

Contains details about company users.

Fields

Example

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

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

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

ComplexTextValue

Fields

Example

{"html": "abc123"}

ConfigurableAttributeOption

Contains details about a configurable product attribute option.

Fields

Example

{
  "code": "xyz789",
  "label": "xyz789",
  "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],
  "errors": [CartItemError],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "xyz789",
  "prices": CartItemPrices,
  "product": ProductInterface,
  "quantity": 123.45,
  "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": "abc123",
  "option_value_uids": [4]
}

ConfigurableProduct

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

Fields

Example

{
  "activity": "xyz789",
  "attribute_set_id": 987,
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "category_gear": "abc123",
  "climate": "xyz789",
  "collar": "xyz789",
  "color": 987,
  "configurable_options": [ConfigurableProductOptions],
  "configurable_product_options_selection": ConfigurableProductOptionsSelection,
  "country_of_manufacture": "abc123",
  "created_at": "abc123",
  "crosssell_products": [ProductInterface],
  "description": ComplexTextValue,
  "eco_collection": 987,
  "erin_recommends": 123,
  "features_bags": "abc123",
  "format": 987,
  "gender": "abc123",
  "gift_message_available": "abc123",
  "id": 987,
  "image": ProductImage,
  "is_returnable": "abc123",
  "manufacturer": 987,
  "material": "xyz789",
  "media_gallery": [MediaGalleryInterface],
  "media_gallery_entries": [MediaGalleryEntry],
  "meta_description": "abc123",
  "meta_keyword": "abc123",
  "meta_title": "xyz789",
  "name": "xyz789",
  "new": 123,
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options": [CustomizableOptionInterface],
  "options_container": "abc123",
  "pattern": "xyz789",
  "performance_fabric": 123,
  "price": ProductPrices,
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "purpose": 987,
  "rating_summary": 987.65,
  "redirect_code": 123,
  "related_products": [ProductInterface],
  "relative_url": "abc123",
  "review_count": 987,
  "reviews": ProductReviews,
  "sale": 987,
  "short_description": ComplexTextValue,
  "size": 987,
  "sku": "abc123",
  "sleeve": "xyz789",
  "small_image": ProductImage,
  "special_from_date": "abc123",
  "special_price": 987.65,
  "special_to_date": "xyz789",
  "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": 123.45,
  "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": "xyz789",
  "variants": [ConfigurableVariant],
  "websites": [Website],
  "weight": 987.65
}

ConfigurableProductCartItemInput

Input Fields

Example

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

ConfigurableProductOption

Contains details about configurable product options.

Fields

Example

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

ConfigurableProductOptionValue

Defines a value for a configurable product option.

Fields

Example

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

ConfigurableProductOptions

Defines configurable attributes for the specified product.

Fields

Example

{
  "attribute_code": "xyz789",
  "attribute_id": "xyz789",
  "attribute_id_v2": 123,
  "attribute_uid": "4",
  "id": 123,
  "label": "abc123",
  "position": 987,
  "product_id": 987,
  "uid": 4,
  "use_default": false,
  "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": "xyz789",
  "label": "abc123",
  "store_label": "abc123",
  "swatch_data": SwatchDataInterface,
  "uid": 4,
  "use_default_value": true,
  "value_index": 123
}

ConfigurableRequisitionListItem

Contains details about configurable products added to a requisition list.

Fields

Example

{
  "configurable_options": [SelectedConfigurableOption],
  "customizable_options": [SelectedCustomizableOption],
  "product": ProductInterface,
  "quantity": 987.65,
  "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": 987.65
}

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": "xyz789",
  "full_name_locale": "xyz789",
  "id": "abc123",
  "three_letter_abbreviation": "xyz789",
  "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}

CreatePayflowProTokenOutput

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

Fields

Example

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

CreateProductReviewInput

Defines a new product review.

Input Fields

Example

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

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

CreateRequisitionListOutput

Output of the request to create a requisition list.

Fields

Example

{"requisition_list": RequisitionList}

CreateWishlistInput

Defines the name and visibility of a new wish list.

Input Fields

Example

{"name": "xyz789", "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": 123,
  "cc_exp_year": 987,
  "cc_last_4": 987,
  "cc_type": "xyz789"
}

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": "abc123",
  "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": "abc123",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "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
}

Currency

Fields

Example

{
  "available_currency_codes": ["abc123"],
  "base_currency_code": "abc123",
  "base_currency_symbol": "abc123",
  "default_display_currecy_code": "abc123",
  "default_display_currecy_symbol": "xyz789",
  "default_display_currency_code": "xyz789",
  "default_display_currency_symbol": "xyz789",
  "exchange_rates": [ExchangeRate]
}

CurrencyEnum

The list of available currency codes.

Values

Example

""AFN""

CustomAttributeMetadata

Defines an array of custom attributes.

Fields

Example

{"items": [Attribute]}

Customer

Defines the customer name, addresses, and other details.

Fields

Example

{
  "addresses": [CustomerAddress],
  "allow_remote_shopping_assistance": true,
  "compare_list": CompareList,
  "created_at": "abc123",
  "date_of_birth": "abc123",
  "default_billing": "abc123",
  "default_shipping": "abc123",
  "dob": "abc123",
  "email": "abc123",
  "firstname": "xyz789",
  "gender": 123,
  "gift_registries": [GiftRegistry],
  "gift_registry": GiftRegistry,
  "group_id": 123,
  "id": 987,
  "is_subscribed": false,
  "job_title": "abc123",
  "lastname": "abc123",
  "middlename": "abc123",
  "orders": CustomerOrders,
  "prefix": "abc123",
  "purchase_order": PurchaseOrder,
  "purchase_order_approval_rule": PurchaseOrderApprovalRule,
  "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata,
  "purchase_order_approval_rules": PurchaseOrderApprovalRules,
  "purchase_orders": PurchaseOrders,
  "purchase_orders_enabled": true,
  "requisition_lists": RequisitionLists,
  "return": Return,
  "returns": Returns,
  "reviews": ProductReviews,
  "reward_points": RewardPoints,
  "role": CompanyRole,
  "status": "ACTIVE",
  "store_credit": CustomerStoreCredit,
  "structure_id": "4",
  "suffix": "xyz789",
  "taxvat": "xyz789",
  "team": CompanyTeam,
  "telephone": "xyz789",
  "wishlist": Wishlist,
  "wishlist_v2": Wishlist,
  "wishlists": [Wishlist]
}

CustomerAddress

Contains detailed information about a customer's billing or shipping address.

Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "AF",
  "country_id": "abc123",
  "custom_attributes": [CustomerAddressAttribute],
  "customer_id": 123,
  "default_billing": false,
  "default_shipping": true,
  "extension_attributes": [CustomerAddressAttribute],
  "fax": "xyz789",
  "firstname": "abc123",
  "id": 123,
  "lastname": "xyz789",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": CustomerAddressRegion,
  "region_id": 987,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "abc123",
  "vat_id": "xyz789"
}

CustomerAddressAttribute

Specifies the attribute code and value of a customer address attribute.

Fields

Example

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

CustomerAddressAttributeInput

Specifies the attribute code and value of a customer attribute.

Input Fields

Example

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

CustomerAddressInput

Contains details about a billing or shipping address.

Input Fields

Example

{
  "city": "xyz789",
  "company": "abc123",
  "country_code": "AF",
  "country_id": "AF",
  "custom_attributes": [CustomerAddressAttributeInput],
  "default_billing": true,
  "default_shipping": false,
  "fax": "xyz789",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "abc123",
  "postcode": "xyz789",
  "prefix": "abc123",
  "region": CustomerAddressRegionInput,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "vat_id": "xyz789"
}

CustomerAddressRegion

Defines the customer's state or province.

Fields

Example

{
  "region": "abc123",
  "region_code": "abc123",
  "region_id": 123
}

CustomerAddressRegionInput

Defines the customer's state or province.

Input Fields

Example

{
  "region": "abc123",
  "region_code": "abc123",
  "region_id": 987
}

CustomerCreateInput

An input object for creating a customer.

Input Fields

Example

{
  "allow_remote_shopping_assistance": false,
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "xyz789",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "abc123",
  "middlename": "xyz789",
  "password": "abc123",
  "prefix": "abc123",
  "suffix": "xyz789",
  "taxvat": "abc123"
}

CustomerDownloadableProduct

Contains details about a single downloadable product.

Fields

Example

{
  "date": "abc123",
  "download_url": "abc123",
  "order_increment_id": "abc123",
  "remaining_downloads": "xyz789",
  "status": "xyz789"
}

CustomerDownloadableProducts

Contains a list of downloadable products.

Fields

Example

{"items": [CustomerDownloadableProduct]}

CustomerInput

An input object that assigns or updates customer attributes.

Input Fields

Example

{
  "date_of_birth": "xyz789",
  "dob": "xyz789",
  "email": "abc123",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "abc123",
  "password": "xyz789",
  "prefix": "xyz789",
  "suffix": "xyz789",
  "taxvat": "abc123"
}

CustomerOrder

Contains details about each of the customer's orders.

Fields

Example

{
  "billing_address": OrderAddress,
  "carrier": "abc123",
  "comments": [SalesCommentItem],
  "created_at": "abc123",
  "credit_memos": [CreditMemo],
  "gift_message": GiftMessage,
  "gift_receipt_included": true,
  "gift_wrapping": GiftWrapping,
  "grand_total": 123.45,
  "id": 4,
  "increment_id": "xyz789",
  "invoices": [Invoice],
  "items": [OrderItemInterface],
  "items_eligible_for_return": [OrderItemInterface],
  "number": "abc123",
  "order_date": "abc123",
  "order_number": "abc123",
  "payment_methods": [OrderPaymentMethod],
  "printed_card_included": false,
  "returns": Returns,
  "shipments": [OrderShipment],
  "shipping_address": OrderAddress,
  "shipping_method": "xyz789",
  "status": "xyz789",
  "total": OrderTotal
}

CustomerOrderSortInput

CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order.

Input Fields

Example

{"sort_direction": "ASC", "sort_field": "NUMBER"}

CustomerOrderSortableField

Specifies the field to use for sorting

Values

Example

""NUMBER""

CustomerOrders

The collection of orders that match the conditions defined in the filter.

Fields

Example

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

CustomerOrdersFilterInput

Identifies the filter to use for filtering orders.

Input Fields

Example

{"number": FilterStringTypeInput}

CustomerOutput

Contains details about a newly-created or updated customer.

Fields

Example

{"customer": Customer}

CustomerPaymentTokens

Contains payment tokens stored in the customer's vault.

Fields

Example

{"items": [PaymentToken]}

CustomerStoreCredit

Contains store credit information with balance and history.

Fields

Example

{
  "balance_history": CustomerStoreCreditHistory,
  "current_balance": Money,
  "enabled": true
}

CustomerStoreCreditHistory

Lists changes to the amount of store credit available to the customer.

Fields

Example

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

CustomerStoreCreditHistoryItem

Contains store credit history information.

Fields

Example

{
  "action": "abc123",
  "actual_balance": Money,
  "balance_change": Money,
  "date_time_changed": "xyz789"
}

CustomerToken

Contains a customer authorization token.

Fields

Example

{"token": "xyz789"}

CustomerUpdateInput

An input object for updating a customer.

Input Fields

Example

{
  "allow_remote_shopping_assistance": false,
  "date_of_birth": "abc123",
  "dob": "xyz789",
  "firstname": "abc123",
  "gender": 987,
  "is_subscribed": true,
  "lastname": "xyz789",
  "middlename": "abc123",
  "prefix": "xyz789",
  "suffix": "abc123",
  "taxvat": "xyz789"
}

CustomizableAreaOption

Contains information about a text area that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 987,
  "product_sku": "xyz789",
  "required": false,
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4,
  "value": CustomizableAreaValue
}

CustomizableAreaValue

Defines the price and sku of a product whose page contains a customized text area.

Fields

Example

{
  "max_characters": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "uid": "4"
}

CustomizableCheckboxOption

Contains information about a set of checkbox values that are defined as part of a customizable option.

Fields

Example

{
  "option_id": 987,
  "required": false,
  "sort_order": 987,
  "title": "abc123",
  "uid": "4",
  "value": [CustomizableCheckboxValue]
}

CustomizableCheckboxValue

Defines the price and sku of a product whose page contains a customized set of checkbox values.

Fields

Example

{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "xyz789",
  "sort_order": 123,
  "title": "xyz789",
  "uid": 4
}

CustomizableDateOption

Contains information about a date picker that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 987,
  "title": "abc123",
  "uid": 4,
  "value": CustomizableDateValue
}

CustomizableDateTypeEnum

Defines the customizable date type.

Values

Example

""DATE""

CustomizableDateValue

Defines the price and sku of a product whose page contains a customized date picker.

Fields

Example

{
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "abc123",
  "type": "DATE",
  "uid": 4
}

CustomizableDropDownOption

Contains information about a drop down menu that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 123,
  "required": true,
  "sort_order": 123,
  "title": "abc123",
  "uid": 4,
  "value": [CustomizableDropDownValue]
}

CustomizableDropDownValue

Defines the price and sku of a product whose page contains a customized drop down menu.

Fields

Example

{
  "option_type_id": 987,
  "price": 987.65,
  "price_type": "FIXED",
  "sku": "abc123",
  "sort_order": 987,
  "title": "xyz789",
  "uid": 4
}

CustomizableFieldOption

Contains information about a text field that is defined as part of a customizable option.

Fields

Example

{
  "option_id": 987,
  "product_sku": "xyz789",
  "required": true,
  "sort_order": 987,
  "title": "abc123",
  "uid": "4",
  "value": CustomizableFieldValue
}

CustomizableFieldValue

Defines the price and sku of a product whose page contains a customized text field.

Fields

Example

{
  "max_characters": 987,
  "price": 123.45,
  "price_type": "FIXED",
  "sku": "xyz789",
  "uid": 4
}