NegotiableQuoteHistoryChanges

Contains a list of changes to a negotiable quote.

Fields

Example

{
  "comment_added": NegotiableQuoteHistoryCommentChange,
  "custom_changes": NegotiableQuoteCustomLogChange,
  "expiration": NegotiableQuoteHistoryExpirationChange,
  "products_removed": NegotiableQuoteHistoryProductsRemovedChange,
  "statuses": NegotiableQuoteHistoryStatusesChange,
  "total": NegotiableQuoteHistoryTotalChange
}

NegotiableQuoteHistoryCommentChange

Contains a comment submitted by a seller or buyer.

Fields

Example

{"comment": "xyz789"}

NegotiableQuoteHistoryEntry

Contains details about a change for a negotiable quote.

Fields

Example

{
  "author": NegotiableQuoteUser,
  "change_type": "CREATED",
  "changes": NegotiableQuoteHistoryChanges,
  "created_at": "abc123",
  "uid": "4"
}

NegotiableQuoteHistoryEntryChangeType

Values

Example

""CREATED""

NegotiableQuoteHistoryExpirationChange

Contains a new expiration date and the previous date.

Fields

Example

{
  "new_expiration": "abc123",
  "old_expiration": "abc123"
}

NegotiableQuoteHistoryProductsRemovedChange

Contains lists of products that have been removed from the catalog and negotiable quote.

Fields

Example

{
  "products_removed_from_catalog": ["4"],
  "products_removed_from_quote": [ProductInterface]
}

NegotiableQuoteHistoryStatusChange

Lists a new status change applied to a negotiable quote and the previous status.

Fields

Example

{"new_status": "SUBMITTED", "old_status": "SUBMITTED"}

NegotiableQuoteHistoryStatusesChange

Contains a list of status changes that occurred for the negotiable quote.

Fields

Example

{"changes": [NegotiableQuoteHistoryStatusChange]}

NegotiableQuoteHistoryTotalChange

Contains a new price and the previous price.

Fields

Example

{
  "new_price": Money,
  "old_price": Money
}

NegotiableQuoteInvalidStateError

An error indicating that an operation was attempted on a negotiable quote in an invalid state.

Fields

Example

{"message": "abc123"}

NegotiableQuoteItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

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

NegotiableQuotePaymentMethodInput

Defines the payment method to be applied to the negotiable quote.

Input Fields

Example

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

NegotiableQuoteReferenceDocumentLink

Contains a reference document link for a negotiable quote template.

Fields

Example

{
  "document_identifier": "xyz789",
  "document_name": "abc123",
  "link_id": "4",
  "reference_document_url": "xyz789"
}

NegotiableQuoteShippingAddress

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "abc123",
  "company": "xyz789",
  "country": NegotiableQuoteAddressCountry,
  "firstname": "abc123",
  "lastname": "xyz789",
  "postcode": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "telephone": "xyz789"
}

NegotiableQuoteShippingAddressInput

Defines shipping addresses for the negotiable quote.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "customer_notes": "abc123"
}

NegotiableQuoteSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Example

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

NegotiableQuoteSortableField

Values

Example

""QUOTE_NAME""

NegotiableQuoteStatus

Values

Example

""SUBMITTED""

NegotiableQuoteTemplate

Contains details about a negotiable quote template.

Fields

Example

{
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "expiration_date": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "is_min_max_qty_used": false,
  "is_virtual": true,
  "items": [CartItemInterface],
  "max_order_commitment": 987,
  "min_order_commitment": 123,
  "name": "xyz789",
  "notifications": [QuoteTemplateNotificationMessage],
  "prices": CartPrices,
  "reference_document_links": [
    NegotiableQuoteReferenceDocumentLink
  ],
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "abc123",
  "template_id": "4",
  "total_quantity": 987.65
}

NegotiableQuoteTemplateFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Example

{
  "state": FilterEqualTypeInput,
  "status": FilterEqualTypeInput
}

NegotiableQuoteTemplateGridItem

Contains data for a negotiable quote template in a grid.

Fields

Example

{
  "activated_at": "abc123",
  "company_name": "abc123",
  "expiration_date": "abc123",
  "is_min_max_qty_used": true,
  "last_shared_at": "xyz789",
  "max_order_commitment": 987,
  "min_negotiated_grand_total": 987.65,
  "min_order_commitment": 987,
  "name": "abc123",
  "orders_placed": 987,
  "sales_rep_name": "abc123",
  "state": "abc123",
  "status": "xyz789",
  "submitted_by": "abc123",
  "template_id": 4
}

NegotiableQuoteTemplateItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

{
  "item_id": "4",
  "max_qty": 987.65,
  "min_qty": 123.45,
  "quantity": 987.65
}

NegotiableQuoteTemplateReferenceDocumentLinkInput

Defines the reference document link to add to a negotiable quote template.

Input Fields

Example

{
  "document_identifier": "xyz789",
  "document_name": "abc123",
  "link_id": "4",
  "reference_document_url": "abc123"
}

NegotiableQuoteTemplateShippingAddressInput

Defines shipping addresses for the negotiable quote template.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "customer_notes": "xyz789"
}

NegotiableQuoteTemplateSortInput

Defines the field to use to sort a list of negotiable quotes.

Input Fields

Example

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

NegotiableQuoteTemplateSortableField

Values

Example

""TEMPLATE_ID""

NegotiableQuoteTemplatesOutput

Contains a list of negotiable templates that match the specified filter.

Fields

Example

{
  "items": [NegotiableQuoteTemplateGridItem],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 123
}

NegotiableQuoteUidNonFatalResultInterface

Fields

Possible Types

Example

{"quote_uid": "4"}

NegotiableQuoteUidOperationSuccess

Contains details about a successful operation on a negotiable quote.

Fields

Example

{"quote_uid": "4"}

NegotiableQuoteUser

A limited view of a Buyer or Seller in the negotiable quote process.

Fields

Example

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

NegotiableQuotesOutput

Contains a list of negotiable that match the specified filter.

Fields

Example

{
  "items": [NegotiableQuote],
  "page_info": SearchResultPageInfo,
  "sort_fields": SortFields,
  "total_count": 987
}

NoSuchEntityUidError

Contains an error message when an invalid UID was specified.

Fields

Example

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

OpenNegotiableQuoteTemplateInput

Specifies the quote template id to open quote template.

Input Fields

Example

{"template_id": "4"}

Order

Contains the order ID.

Fields

Example

{
  "order_id": "abc123",
  "order_number": "xyz789"
}

OrderActionType

The list of available order actions.

Values

Example

""REORDER""

OrderAddress

Contains detailed information about an order's billing and shipping addresses.

Fields

Example

{
  "city": "abc123",
  "company": "abc123",
  "country_code": "AF",
  "custom_attributesV2": [AttributeValueInterface],
  "fax": "abc123",
  "firstname": "xyz789",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "xyz789",
  "prefix": "xyz789",
  "region": "abc123",
  "region_id": "4",
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "vat_id": "abc123"
}

OrderCustomerInfo

Fields

Example

{
  "firstname": "xyz789",
  "lastname": "xyz789",
  "middlename": "abc123",
  "prefix": "xyz789",
  "suffix": "abc123"
}

OrderItem

Fields

Example

{
  "discounts": [Discount],
  "eligible_for_return": true,
  "entered_options": [OrderItemOption],
  "gift_message": GiftMessage,
  "gift_wrapping": GiftWrapping,
  "id": "4",
  "prices": OrderItemPrices,
  "product": ProductInterface,
  "product_name": "xyz789",
  "product_sale_price": Money,
  "product_sku": "xyz789",
  "product_type": "xyz789",
  "product_url_key": "xyz789",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 987.65,
  "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": "xyz789"
}

OrderItemInterface

Order item details.

Fields

Possible Types

Example

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

OrderItemOption

Represents order item options like selected or entered.

Fields

Example

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

OrderItemPrices

Fields

Example

{
  "discounts": [Discount],
  "fixed_product_taxes": [FixedProductTax],
  "original_price": Money,
  "original_price_including_tax": Money,
  "original_row_total": Money,
  "original_row_total_including_tax": Money,
  "price": Money,
  "price_including_tax": Money,
  "row_total": Money,
  "row_total_including_tax": Money,
  "total_item_discount": Money
}

OrderPaymentMethod

Contains details about the payment method used to pay for the order.

Fields

Example

{
  "additional_data": [KeyValue],
  "name": "abc123",
  "type": "xyz789"
}

OrderShipment

Contains order shipment details.

Fields

Example

{
  "comments": [SalesCommentItem],
  "id": 4,
  "items": [ShipmentItemInterface],
  "number": "abc123",
  "tracking": [ShipmentTracking]
}

OrderTokenInput

Input to retrieve an order based on token.

Input Fields

Example

{"token": "xyz789"}

OrderTotal

Contains details about the sales total amounts used to calculate the final price.

Fields

Example

{
  "base_grand_total": Money,
  "discounts": [Discount],
  "gift_options": GiftOptionsPrices,
  "grand_total": Money,
  "grand_total_excl_tax": Money,
  "shipping_handling": ShippingHandling,
  "subtotal": Money,
  "subtotal_excl_tax": Money,
  "subtotal_incl_tax": Money,
  "taxes": [TaxItem],
  "total_giftcard": Money,
  "total_reward_points": Money,
  "total_shipping": Money,
  "total_store_credit": Money,
  "total_tax": Money
}

PayflowExpressInput

Contains required input for Payflow Express Checkout payments.

Input Fields

Example

{
  "payer_id": "xyz789",
  "token": "xyz789"
}

PayflowLinkInput

A set of relative URLs that PayPal uses in response to various actions during the authorization process. Adobe Commerce prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Payflow Link and Payments Advanced payment methods.

Input Fields

Example

{
  "cancel_url": "abc123",
  "error_url": "abc123",
  "return_url": "abc123"
}

PayflowLinkMode

Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods.

Values

Example

""TEST""

PayflowLinkToken

Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods.

Fields

Example

{
  "mode": "TEST",
  "paypal_url": "abc123",
  "secure_token": "xyz789",
  "secure_token_id": "xyz789"
}

PayflowLinkTokenInput

Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods.

Input Fields

Example

{"cart_id": "abc123"}

PayflowProInput

Contains input for the Payflow Pro and Payments Pro payment methods.

Input Fields

Example

{
  "cc_details": CreditCardDetailsInput,
  "is_active_payment_token_enabler": false
}

PayflowProResponseInput

Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods.

Input Fields

Example

{
  "cart_id": "xyz789",
  "paypal_payload": "xyz789"
}

PayflowProResponseOutput

Fields

Example

{"cart": Cart}

PayflowProTokenInput

Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods.

Input Fields

Example

{
  "cart_id": "abc123",
  "urls": PayflowProUrlInput
}

PayflowProUrlInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for the Payflow Pro and Payment Pro payment methods.

Input Fields

Example

{
  "cancel_url": "abc123",
  "error_url": "abc123",
  "return_url": "xyz789"
}

PaymentConfigItem

Contains payment fields that are common to all types of payment methods.

Fields

Possible Types

Example

{
  "code": "xyz789",
  "is_visible": false,
  "payment_intent": "xyz789",
  "sdk_params": [SDKParams],
  "sort_order": "abc123",
  "title": "xyz789"
}

PaymentConfigOutput

Retrieves the payment configuration for a given location

Fields

Example

{
  "apple_pay": ApplePayConfig,
  "fastlane": FastlaneConfig,
  "google_pay": GooglePayConfig,
  "hosted_fields": HostedFieldsConfig,
  "smart_buttons": SmartButtonsConfig
}

PaymentLocation

Defines the origin location for that payment request

Values

Example

""PRODUCT_DETAIL""

PaymentMethodInput

Defines the payment method.

Input Fields

Example

{
  "braintree": BraintreeInput,
  "braintree_ach_direct_debit": BraintreeInput,
  "braintree_ach_direct_debit_vault": BraintreeVaultInput,
  "braintree_applepay_vault": BraintreeVaultInput,
  "braintree_cc_vault": BraintreeCcVaultInput,
  "braintree_googlepay_vault": BraintreeVaultInput,
  "braintree_paypal": BraintreeInput,
  "braintree_paypal_vault": BraintreeVaultInput,
  "code": "xyz789",
  "hosted_pro": HostedProInput,
  "payflow_express": PayflowExpressInput,
  "payflow_link": PayflowLinkInput,
  "payflowpro": PayflowProInput,
  "payflowpro_cc_vault": VaultTokenInput,
  "payment_services_paypal_apple_pay": ApplePayMethodInput,
  "payment_services_paypal_fastlane": FastlaneMethodInput,
  "payment_services_paypal_google_pay": GooglePayMethodInput,
  "payment_services_paypal_hosted_fields": HostedFieldsInput,
  "payment_services_paypal_smart_buttons": SmartButtonMethodInput,
  "payment_services_paypal_vault": VaultMethodInput,
  "paypal_express": PaypalExpressInput,
  "purchase_order_number": "xyz789"
}

PaymentOrderOutput

Contains the payment order details

Fields

Example

{
  "id": "abc123",
  "mp_order_id": "xyz789",
  "payment_source_details": PaymentSourceDetails,
  "status": "xyz789"
}

PaymentSDKParamsItem

Fields

Example

{
  "code": "abc123",
  "params": [SDKParams]
}

PaymentSourceDetails

Fields

Example

{"card": Card}

PaymentSourceInput

The payment source information

Input Fields

Example

{"card": CardPaymentSourceInput}

PaymentSourceOutput

The payment source information

Fields

Example

{"card": CardPaymentSourceOutput}

PaymentToken

The stored payment method available to the customer.

Fields

Example

{
  "details": "abc123",
  "payment_method_code": "abc123",
  "public_hash": "abc123",
  "type": "card"
}

PaymentTokenTypeEnum

The list of available payment token types.

Values

Example

""card""

PaypalExpressInput

Contains required input for Express Checkout and Payments Standard payments.

Input Fields

Example

{
  "payer_id": "xyz789",
  "token": "xyz789"
}

PaypalExpressTokenInput

Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods.

Input Fields

Example

{
  "cart_id": "abc123",
  "code": "xyz789",
  "express_button": false,
  "urls": PaypalExpressUrlsInput,
  "use_paypal_credit": true
}

PaypalExpressTokenOutput

Contains the token returned by PayPal and a set of URLs that allow the buyer to authorize payment and adjust checkout details. Applies to Express Checkout and Payments Standard payment methods.

Fields

Example

{
  "paypal_urls": PaypalExpressUrlList,
  "token": "abc123"
}

PaypalExpressUrlList

Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions.

Fields

Example

{
  "edit": "abc123",
  "start": "xyz789"
}

PaypalExpressUrlsInput

Contains a set of relative URLs that PayPal uses in response to various actions during the authorization process. Magento prepends the base URL to this value to create a full URL. For example, if the full URL is https://www.example.com/path/to/page.html, the relative URL is path/to/page.html. Use this input for Express Checkout and Payments Standard payment methods.

Input Fields

Example

{
  "cancel_url": "xyz789",
  "pending_url": "xyz789",
  "return_url": "xyz789",
  "success_url": "abc123"
}

PhysicalProductInterface

Contains attributes specific to tangible products.

Fields

Possible Types

Example

{"weight": 123.45}

PickupLocation

Defines Pickup Location information.

Fields

Example

{
  "city": "xyz789",
  "contact_name": "abc123",
  "country_id": "xyz789",
  "description": "xyz789",
  "email": "abc123",
  "fax": "xyz789",
  "latitude": 123.45,
  "longitude": 987.65,
  "name": "abc123",
  "phone": "xyz789",
  "pickup_location_code": "xyz789",
  "postcode": "abc123",
  "region": "abc123",
  "region_id": 123,
  "street": "abc123"
}

PickupLocationFilterInput

PickupLocationFilterInput defines the list of attributes and filters for the search.

Input Fields

Example

{
  "city": FilterTypeInput,
  "country_id": FilterTypeInput,
  "name": FilterTypeInput,
  "pickup_location_code": FilterTypeInput,
  "postcode": FilterTypeInput,
  "region": FilterTypeInput,
  "region_id": FilterTypeInput,
  "street": FilterTypeInput
}

PickupLocationSortInput

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

Input Fields

Example

{
  "city": "ASC",
  "contact_name": "ASC",
  "country_id": "ASC",
  "description": "ASC",
  "distance": "ASC",
  "email": "ASC",
  "fax": "ASC",
  "latitude": "ASC",
  "longitude": "ASC",
  "name": "ASC",
  "phone": "ASC",
  "pickup_location_code": "ASC",
  "postcode": "ASC",
  "region": "ASC",
  "region_id": "ASC",
  "street": "ASC"
}

PickupLocations

Top level object returned in a pickup locations search.

Fields

Example

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

PlaceNegotiableQuoteOrderInput

Specifies the negotiable quote to convert to an order.

Input Fields

Example

{"quote_uid": "4"}

PlaceNegotiableQuoteOrderOutput

An output object that returns the generated order.

Fields

Example

{"order": Order}

PlaceOrderError

An error encountered while placing an order.

Fields

Example

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

PlaceOrderErrorCodes

Values

Example

""CART_NOT_FOUND""

PlaceOrderForPurchaseOrderInput

Specifies the purchase order to convert to an order.

Input Fields

Example

{"purchase_order_uid": 4}

PlaceOrderForPurchaseOrderOutput

Contains the results of the request to place an order.

Fields

Example

{"order": CustomerOrder}

PlaceOrderInput

Specifies the quote to be converted to an order.

Input Fields

Example

{"cart_id": "xyz789"}

PlaceOrderOutput

Contains the results of the request to place an order.

Fields

Example

{
  "errors": [PlaceOrderError],
  "order": Order,
  "orderV2": CustomerOrder
}

PlacePurchaseOrderInput

Specifies the quote to be converted to a purchase order.

Input Fields

Example

{"cart_id": "abc123"}

PlacePurchaseOrderOutput

Contains the results of the request to place a purchase order.

Fields

Example

{"purchase_order": PurchaseOrder}

Price

Deprecated. Use ProductPrice instead. Defines the price of a product as well as any tax-related adjustments.

Fields

Example

{
  "adjustments": [PriceAdjustment],
  "amount": Money
}

PriceAdjustment

Deprecated. Taxes will be included or excluded in the price. Defines the amount of money to apply as an adjustment, the type of adjustment to apply, and whether the item is included or excluded from the adjustment.

Fields

Example

{
  "amount": Money,
  "code": "TAX",
  "description": "INCLUDED"
}

PriceAdjustmentCodesEnum

PriceAdjustment.code is deprecated.

Values

Example

""TAX""

PriceAdjustmentDescriptionEnum

PriceAdjustmentDescriptionEnum is deprecated. States whether a price adjustment is included or excluded.

Values

Example

""INCLUDED""

PriceDetails

Can be used to retrieve the main price details in case of bundle product

Fields

Example

{
  "discount_percentage": 987.65,
  "main_final_price": 123.45,
  "main_price": 123.45
}

PriceRange

Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same.

Fields

Example

{
  "maximum_price": ProductPrice,
  "minimum_price": ProductPrice
}

PriceTypeEnum

Defines the price type.

Values

Example

""FIXED""

PriceViewEnum

Defines whether a bundle product's price is displayed as the lowest possible value or as a range.

Values

Example

""PRICE_RANGE""

ProductAttribute

Contains a product attribute code and value.

Fields

Example

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

ProductAttributeFilterInput

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_id": FilterEqualTypeInput,
  "category_uid": FilterEqualTypeInput,
  "category_url_path": FilterEqualTypeInput,
  "description": FilterMatchTypeInput,
  "name": FilterMatchTypeInput,
  "price": FilterRangeTypeInput,
  "short_description": FilterMatchTypeInput,
  "sku": FilterEqualTypeInput,
  "url_key": FilterEqualTypeInput
}

ProductAttributeSortInput

Specifies the attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. It's possible to sort products using searchable attributes with enabled 'Use in Filter Options' option

Input Fields

Example

{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"}

ProductCustomAttributes

Product custom attributes

Fields

Example

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

ProductDiscount

Contains the discount applied to a product price.

Fields

Example

{"amount_off": 987.65, "percent_off": 987.65}

ProductFilterInput

ProductFilterInput is deprecated, use @ProductAttributeFilterInput instead. ProductFilterInput 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_id": FilterTypeInput,
  "country_of_manufacture": FilterTypeInput,
  "created_at": FilterTypeInput,
  "custom_layout": FilterTypeInput,
  "custom_layout_update": FilterTypeInput,
  "description": FilterTypeInput,
  "gift_message_available": FilterTypeInput,
  "has_options": FilterTypeInput,
  "image": FilterTypeInput,
  "image_label": FilterTypeInput,
  "is_returnable": FilterTypeInput,
  "manufacturer": FilterTypeInput,
  "max_price": FilterTypeInput,
  "meta_description": FilterTypeInput,
  "meta_keyword": FilterTypeInput,
  "meta_title": FilterTypeInput,
  "min_price": FilterTypeInput,
  "name": FilterTypeInput,
  "news_from_date": FilterTypeInput,
  "news_to_date": FilterTypeInput,
  "options_container": FilterTypeInput,
  "or": ProductFilterInput,
  "price": FilterTypeInput,
  "required_options": FilterTypeInput,
  "short_description": FilterTypeInput,
  "sku": FilterTypeInput,
  "small_image": FilterTypeInput,
  "small_image_label": FilterTypeInput,
  "special_from_date": FilterTypeInput,
  "special_price": FilterTypeInput,
  "special_to_date": FilterTypeInput,
  "swatch_image": FilterTypeInput,
  "thumbnail": FilterTypeInput,
  "thumbnail_label": FilterTypeInput,
  "tier_price": FilterTypeInput,
  "updated_at": FilterTypeInput,
  "url_key": FilterTypeInput,
  "url_path": FilterTypeInput,
  "weight": FilterTypeInput
}

ProductImage

Contains product image information, including the image URL and label.

Fields

Example

{
  "disabled": false,
  "label": "xyz789",
  "position": 987,
  "types": ["abc123"],
  "url": "abc123"
}

ProductImageThumbnail

Values

Example

""ITSELF""

ProductInfoInput

Product Information used for Pickup Locations search.

Input Fields

Example

{"sku": "xyz789"}

ProductInterface

Contains fields that are common to all types of products.

Fields

Possible Types

Example

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

ProductLinks

An implementation of ProductLinksInterface.

Fields

Example

{
  "link_type": "xyz789",
  "linked_product_sku": "abc123",
  "linked_product_type": "xyz789",
  "position": 987,
  "sku": "xyz789"
}

ProductLinksInterface

Contains information about linked products, including the link type and product type of each item.

Fields

Possible Types

Example

{
  "link_type": "xyz789",
  "linked_product_sku": "xyz789",
  "linked_product_type": "xyz789",
  "position": 987,
  "sku": "xyz789"
}

ProductMediaGalleryEntriesContent

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

Fields

Example

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

ProductMediaGalleryEntriesVideoContent

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

Fields

Example

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

ProductPrice

Represents a product price.

Fields

Example

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

ProductPrices

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

Fields

Example

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

ProductReview

Contains details of a product review.

Fields

Example

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

ProductReviewRating

Contains data about a single aspect of a product review.

Fields

Example

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

ProductReviewRatingInput

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

Input Fields

Example

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

ProductReviewRatingMetadata

Contains details about a single aspect of a product review.

Fields

Example

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

ProductReviewRatingValueMetadata

Contains details about a single value in a product review.

Fields

Example

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

ProductReviewRatingsMetadata

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

Fields

Example

{"items": [ProductReviewRatingMetadata]}

ProductReviews

Contains an array of product reviews.

Fields

Example

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

ProductStockStatus

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

Values

Example

""IN_STOCK""

ProductTierPrices

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

Fields

Example

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

ProductVideo

Contains information about a product video.

Fields

Example

{
  "disabled": false,
  "label": "xyz789",
  "position": 123,
  "types": ["xyz789"],
  "url": "xyz789",
  "video_content": ProductMediaGalleryEntriesVideoContent
}

Products

Contains the results of a products query.

Fields

Example

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

PurchaseOrder

Contains details about a purchase order.

Fields

Example

{
  "approval_flow": [PurchaseOrderRuleApprovalFlow],
  "available_actions": ["REJECT"],
  "comments": [PurchaseOrderComment],
  "created_at": "abc123",
  "created_by": Customer,
  "history_log": [PurchaseOrderHistoryItem],
  "number": "abc123",
  "order": CustomerOrder,
  "quote": Cart,
  "status": "PENDING",
  "uid": 4,
  "updated_at": "abc123"
}

PurchaseOrderAction

Values

Example

""REJECT""

PurchaseOrderActionError

Contains details about a failed action.

Fields

Example

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

PurchaseOrderApprovalFlowEvent

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

Fields

Example

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

PurchaseOrderApprovalFlowItemStatus

Values

Example

""PENDING""

PurchaseOrderApprovalRule

Contains details about a purchase order approval rule.

Fields

Example

{
  "applies_to_roles": [CompanyRole],
  "approver_roles": [CompanyRole],
  "condition": PurchaseOrderApprovalRuleConditionInterface,
  "created_at": "xyz789",
  "created_by": "xyz789",
  "description": "xyz789",
  "name": "xyz789",
  "status": "ENABLED",
  "uid": "4",
  "updated_at": "xyz789"
}

PurchaseOrderApprovalRuleConditionAmount

Contains approval rule condition details, including the amount to be evaluated.

Fields

Example

{
  "amount": Money,
  "attribute": "GRAND_TOTAL",
  "operator": "MORE_THAN"
}

PurchaseOrderApprovalRuleConditionInterface

Purchase order rule condition details.

Fields

Possible Types

Example

{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"}

PurchaseOrderApprovalRuleConditionOperator

Values

Example

""MORE_THAN""

PurchaseOrderApprovalRuleConditionQuantity

Contains approval rule condition details, including the quantity to be evaluated.

Fields

Example

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

PurchaseOrderApprovalRuleInput

Defines a new purchase order approval rule.

Input Fields

Example

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

PurchaseOrderApprovalRuleMetadata

Contains metadata that can be used to render rule edit forms.

Fields

Example

{
  "available_applies_to": [CompanyRole],
  "available_condition_currencies": [AvailableCurrency],
  "available_requires_approval_from": [CompanyRole]
}

PurchaseOrderApprovalRuleStatus

Values

Example

""ENABLED""

PurchaseOrderApprovalRuleType

Values

Example

""GRAND_TOTAL""

PurchaseOrderApprovalRules

Contains the approval rules that the customer can see.

Fields

Example

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

PurchaseOrderComment

Contains details about a comment.

Fields

Example

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

PurchaseOrderErrorType

Values

Example

""NOT_FOUND""

PurchaseOrderHistoryItem

Contains details about a status change.

Fields

Example

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

PurchaseOrderRuleApprovalFlow

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

Fields

Example

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

PurchaseOrderStatus

Values

Example

""PENDING""

PurchaseOrders

Contains a list of purchase orders.

Fields

Example

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

PurchaseOrdersActionInput

Defines which purchase orders to act on.

Input Fields

Example

{"purchase_order_uids": [4]}

PurchaseOrdersActionOutput

Returns a list of updated purchase orders and any error messages.

Fields

Example

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

PurchaseOrdersFilterInput

Defines the criteria to use to filter the list of purchase orders.

Input Fields

Example

{
  "company_purchase_orders": false,
  "created_date": FilterRangeTypeInput,
  "require_my_approval": false,
  "status": "PENDING"
}

QuoteItemsSortInput

Specifies the field to use for sorting quote items

Input Fields

Example

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

QuoteTemplateLineItemNoteInput

Sets quote item note.

Input Fields

Example

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

QuoteTemplateNotificationMessage

Contains a notification message for a negotiable quote template.

Fields

Example

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

ReCaptchaConfigOutput

Fields

Example

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

ReCaptchaConfiguration

Contains reCAPTCHA form configuration details.

Fields

Example

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

ReCaptchaConfigurationV3

Contains reCAPTCHA V3-Invisible configuration details.

Fields

Example

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

ReCaptchaFormEnum

Values

Example

""PLACE_ORDER""

ReCaptchaTypeEmum

Values

Example

""INVISIBLE""

Region

Fields

Example

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

RemoveCouponFromCartInput

Specifies the cart from which to remove a coupon.

Input Fields

Example

{"cart_id": "xyz789"}

RemoveCouponFromCartOutput

Contains details about the cart after removing a coupon.

Fields

Example

{"cart": Cart}

RemoveCouponsFromCartInput

Remove coupons from the cart.

Input Fields

Example

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

RemoveGiftCardFromCartInput

Defines the input required to run the removeGiftCardFromCart mutation.

Input Fields

Example

{
  "cart_id": "xyz789",
  "gift_card_code": "xyz789"
}

RemoveGiftCardFromCartOutput

Defines the possible output for the removeGiftCardFromCart mutation.

Fields

Example

{"cart": Cart}

RemoveGiftRegistryItemsOutput

Contains the results of a request to remove an item from a gift registry.

Fields

Example

{"gift_registry": GiftRegistry}

RemoveGiftRegistryOutput

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

Fields

Example

{"success": true}

RemoveGiftRegistryRegistrantsOutput

Contains the results of a request to delete a registrant.

Fields

Example

{"gift_registry": GiftRegistry}

RemoveItemFromCartInput

Specifies which items to remove from the cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "cart_item_id": 123,
  "cart_item_uid": 4
}

RemoveItemFromCartOutput

Contains details about the cart after removing an item.

Fields

Example

{"cart": Cart}

RemoveNegotiableQuoteItemsInput

Defines the items to remove from the specified negotiable quote.

Input Fields

Example

{"quote_item_uids": ["4"], "quote_uid": 4}

RemoveNegotiableQuoteItemsOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

RemoveNegotiableQuoteTemplateItemsInput

Defines the items to remove from the specified negotiable quote.

Input Fields

Example

{"item_uids": [4], "template_id": "4"}

RemoveProductsFromCompareListInput

Defines which products to remove from a compare list.

Input Fields

Example

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

RemoveProductsFromWishlistOutput

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

Fields

Example

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

RemoveReturnTrackingInput

Defines the tracking information to delete.

Input Fields

Example

{"return_shipping_tracking_uid": "4"}

RemoveReturnTrackingOutput

Contains the response after deleting tracking information.

Fields

Example

{"return": Return}

RemoveRewardPointsFromCartOutput

Contains the customer cart.

Fields

Example

{"cart": Cart}

RemoveStoreCreditFromCartInput

Defines the input required to run the removeStoreCreditFromCart mutation.

Input Fields

Example

{"cart_id": "abc123"}

RemoveStoreCreditFromCartOutput

Defines the possible output for the removeStoreCreditFromCart mutation.

Fields

Example

{"cart": Cart}

RenameNegotiableQuoteInput

Sets new name for a negotiable quote.

Input Fields

Example

{
  "quote_comment": "xyz789",
  "quote_name": "abc123",
  "quote_uid": "4"
}

RenameNegotiableQuoteOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

ReorderItemsOutput

Contains the cart and any errors after adding products.

Fields

Example

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

RequestGuestReturnInput

Contains information needed to start a return request.

Input Fields

Example

{
  "comment_text": "xyz789",
  "contact_email": "xyz789",
  "items": [RequestReturnItemInput],
  "token": "abc123"
}

RequestNegotiableQuoteInput

Defines properties of a negotiable quote request.

Input Fields

Example

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

RequestNegotiableQuoteOutput

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

Fields

Example

{"quote": NegotiableQuote}

RequestNegotiableQuoteTemplateInput

Defines properties of a negotiable quote template request.

Input Fields

Example

{"cart_id": 4}

RequestReturnInput

Contains information needed to start a return request.

Input Fields

Example

{
  "comment_text": "xyz789",
  "contact_email": "abc123",
  "items": [RequestReturnItemInput],
  "order_uid": 4
}

RequestReturnItemInput

Contains details about an item to be returned.

Input Fields

Example

{
  "entered_custom_attributes": [
    EnteredCustomAttributeInput
  ],
  "order_item_uid": 4,
  "quantity_to_return": 123.45,
  "selected_custom_attributes": [
    SelectedCustomAttributeInput
  ]
}

RequestReturnOutput

Contains the response to a return request.

Fields

Example

{
  "return": Return,
  "returns": Returns
}

RequisitionList

Defines the contents of a requisition list.

Fields

Example

{
  "description": "abc123",
  "items": RequistionListItems,
  "items_count": 123,
  "name": "xyz789",
  "requisition_list_items": RequisitionListItems,
  "uid": "4",
  "updated_at": "abc123"
}

RequisitionListFilterInput

Defines requisition list filters.

Input Fields

Example

{
  "name": FilterMatchTypeInput,
  "uids": FilterEqualTypeInput
}

RequisitionListItemInterface

The interface for requisition list items.

Fields

Possible Types

Example

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

RequisitionListItems

Contains an array of items added to a requisition list.

Fields

Example

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

RequisitionListItemsInput

Defines the items to add.

Input Fields

Example

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

RequisitionLists

Defines customer requisition lists.

Fields

Example

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

RequistionListItems

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

Fields

Example

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

Return

Contains details about a return.

Fields

Example

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

ReturnComment

Contains details about a return comment.

Fields

Example

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

ReturnCustomAttribute

Contains details about a ReturnCustomerAttribute object.

Fields

Example

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

ReturnCustomer

The customer information for the return.

Fields

Example

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

ReturnItem

Contains details about a product being returned.

Fields

Example

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

ReturnItemAttributeMetadata

Return Item attribute metadata.

Fields

Example

{
  "code": 4,
  "default_value": "abc123",
  "entity_type": "CATALOG_PRODUCT",
  "frontend_class": "xyz789",
  "frontend_input": "BOOLEAN",
  "input_filter": "NONE",
  "is_required": false,
  "is_unique": true,
  "label": "xyz789",
  "multiline_count": 987,
  "options": [CustomAttributeOptionInterface],
  "sort_order": 987,
  "validate_rules": [ValidationRule]
}

ReturnItemStatus

Values

Example

""PENDING""

ReturnShipping

Contains details about the return shipping address.

Fields

Example

{
  "address": ReturnShippingAddress,
  "tracking": [ReturnShippingTracking]
}

ReturnShippingAddress

Contains details about the shipping address used for receiving returned items.

Fields

Example

{
  "city": "xyz789",
  "contact_name": "xyz789",
  "country": Country,
  "postcode": "abc123",
  "region": Region,
  "street": ["xyz789"],
  "telephone": "xyz789"
}

ReturnShippingCarrier

Contains details about the carrier on a return.

Fields

Example

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

ReturnShippingTracking

Contains shipping and tracking details.

Fields

Example

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

ReturnShippingTrackingStatus

Contains the status of a shipment.

Fields

Example

{"text": "abc123", "type": "INFORMATION"}

ReturnShippingTrackingStatusType

Values

Example

""INFORMATION""

ReturnStatus

Values

Example

""PENDING""

Returns

Contains a list of customer return requests.

Fields

Example

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

RevokeCustomerTokenOutput

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

Fields

Example

{"result": true}

RewardPoints

Contains details about a customer's reward points.

Fields

Example

{
  "balance": RewardPointsAmount,
  "balance_history": [RewardPointsBalanceHistoryItem],
  "exchange_rates": RewardPointsExchangeRates,
  "subscription_status": RewardPointsSubscriptionStatus
}

RewardPointsAmount

Fields

Example

{"money": Money, "points": 123.45}

RewardPointsBalanceHistoryItem

Contain details about the reward points transaction.

Fields

Example

{
  "balance": RewardPointsAmount,
  "change_reason": "abc123",
  "date": "abc123",
  "points_change": 987.65
}

RewardPointsExchangeRates

Lists the reward points exchange rates. The values depend on the customer group.

Fields

Example

{
  "earning": RewardPointsRate,
  "redemption": RewardPointsRate
}

RewardPointsRate

Contains details about customer's reward points rate.

Fields

Example

{"currency_amount": 123.45, "points": 987.65}

RewardPointsSubscriptionStatus

Indicates whether the customer subscribes to reward points emails.

Fields

Example

{
  "balance_updates": "SUBSCRIBED",
  "points_expiration_notifications": "SUBSCRIBED"
}

RewardPointsSubscriptionStatusesEnum

Values

Example

""SUBSCRIBED""

RoutableInterface

Routable entities serve as the model for a rendered page.

Fields

Possible Types

Example

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

RoutableUrl

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

Fields

Example

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

SDKParams

Defines the name and value of a SDK parameter

Fields

Example

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

SalesCommentItem

Contains details about a comment.

Fields

Example

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

ScopeTypeEnum

This enumeration defines the scope type for customer orders.

Values

Example

""GLOBAL""

SearchResultPageInfo

Provides navigation for the query response.

Fields

Example

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

SearchSuggestion

A string that contains search suggestion

Fields

Example

{"search": "xyz789"}

SelectedBundleOption

Contains details about a selected bundle option.

Fields

Example

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

SelectedBundleOptionValue

Contains details about a value for a selected bundle option.

Fields

Example

{
  "id": 123,
  "label": "abc123",
  "original_price": Money,
  "price": 987.65,
  "priceV2": Money,
  "quantity": 123.45,
  "uid": "4"
}

SelectedConfigurableOption

Contains details about a selected configurable option.

Fields

Example

{
  "configurable_product_option_uid": 4,
  "configurable_product_option_value_uid": "4",
  "id": 123,
  "option_label": "xyz789",
  "value_id": 123,
  "value_label": "xyz789"
}

SelectedCustomAttributeInput

Contains details about an attribute the buyer selected.

Input Fields

Example

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

SelectedCustomizableOption

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

Fields

Example

{
  "customizable_option_uid": 4,
  "id": 123,
  "is_required": false,
  "label": "xyz789",
  "sort_order": 987,
  "type": "xyz789",
  "values": [SelectedCustomizableOptionValue]
}

SelectedCustomizableOptionValue

Identifies the value of the selected customized option.

Fields

Example

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

SelectedPaymentMethod

Describes the payment method the shopper selected.

Fields

Example

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

SelectedShippingMethod

Contains details about the selected shipping method and carrier.

Fields

Example

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

SendEmailToFriendInput

Defines the referenced product and the email sender and recipients.

Input Fields

Example

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

SendEmailToFriendOutput

Contains information about the sender and recipients.

Fields

Example

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

SendEmailToFriendRecipient

An output object that contains information about the recipient.

Fields

Example

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

SendEmailToFriendRecipientInput

Contains details about a recipient.

Input Fields

Example

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

SendEmailToFriendSender

An output object that contains information about the sender.

Fields

Example

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

SendEmailToFriendSenderInput

Contains details about the sender.

Input Fields

Example

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

SendFriendConfiguration

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

Fields

Example

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

SendNegotiableQuoteForReviewInput

Specifies which negotiable quote to send for review.

Input Fields

Example

{"comment": NegotiableQuoteCommentInput, "quote_uid": 4}

SendNegotiableQuoteForReviewOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetBillingAddressOnCartInput

Sets the billing address.

Input Fields

Example

{
  "billing_address": BillingAddressInput,
  "cart_id": "xyz789"
}

SetBillingAddressOnCartOutput

Contains details about the cart after setting the billing address.

Fields

Example

{"cart": Cart}

SetCartAsInactiveOutput

Sets the cart as inactive

Fields

Example

{"error": "abc123", "success": true}

SetGiftOptionsOnCartInput

Defines the gift options applied to the cart.

Input Fields

Example

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

SetGiftOptionsOnCartOutput

Contains the cart after gift options have been applied.

Fields

Example

{"cart": Cart}

SetGuestEmailOnCartInput

Defines the guest email and cart.

Input Fields

Example

{
  "cart_id": "xyz789",
  "email": "xyz789"
}

SetGuestEmailOnCartOutput

Contains details about the cart after setting the email of a guest.

Fields

Example

{"cart": Cart}

SetLineItemNoteOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteBillingAddressInput

Sets the billing address.

Input Fields

Example

{
  "billing_address": NegotiableQuoteBillingAddressInput,
  "quote_uid": "4"
}

SetNegotiableQuoteBillingAddressOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuotePaymentMethodInput

Defines the payment method of the specified negotiable quote.

Input Fields

Example

{
  "payment_method": NegotiableQuotePaymentMethodInput,
  "quote_uid": "4"
}

SetNegotiableQuotePaymentMethodOutput

Contains details about the negotiable quote after setting the payment method.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteShippingAddressInput

Defines the shipping address to assign to the negotiable quote.

Input Fields

Example

{
  "customer_address_id": 4,
  "quote_uid": 4,
  "shipping_addresses": [
    NegotiableQuoteShippingAddressInput
  ]
}

SetNegotiableQuoteShippingAddressOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteShippingMethodsInput

Defines the shipping method to apply to the negotiable quote.

Input Fields

Example

{
  "quote_uid": "4",
  "shipping_methods": [ShippingMethodInput]
}

SetNegotiableQuoteShippingMethodsOutput

Contains the negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

SetNegotiableQuoteTemplateShippingAddressInput

Defines the shipping address to assign to the negotiable quote template.

Input Fields

Example

{
  "shipping_address": NegotiableQuoteTemplateShippingAddressInput,
  "template_id": 4
}

SetPaymentMethodAndPlaceOrderInput

Applies a payment method to the quote.

Input Fields

Example

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

SetPaymentMethodOnCartInput

Applies a payment method to the cart.

Input Fields

Example

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

SetPaymentMethodOnCartOutput

Contains details about the cart after setting the payment method.

Fields

Example

{"cart": Cart}

SetShippingAddressesOnCartInput

Specifies an array of addresses to use for shipping.

Input Fields

Example

{
  "cart_id": "abc123",
  "shipping_addresses": [ShippingAddressInput]
}

SetShippingAddressesOnCartOutput

Contains details about the cart after setting the shipping addresses.

Fields

Example

{"cart": Cart}

SetShippingMethodsOnCartInput

Applies one or shipping methods to the cart.

Input Fields

Example

{
  "cart_id": "abc123",
  "shipping_methods": [ShippingMethodInput]
}

SetShippingMethodsOnCartOutput

Contains details about the cart after setting the shipping methods.

Fields

Example

{"cart": Cart}

ShareGiftRegistryInviteeInput

Defines a gift registry invitee.

Input Fields

Example

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

ShareGiftRegistryOutput

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

Fields

Example

{"is_shared": false}

ShareGiftRegistrySenderInput

Defines the sender of an invitation to view a gift registry.

Input Fields

Example

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

ShipBundleItemsEnum

Defines whether bundle items must be shipped together.

Values

Example

""TOGETHER""

ShipmentItem

Fields

Example

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

ShipmentItemInterface

Order shipment item details.

Fields

Possible Types

Example

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

ShipmentTracking

Contains order shipment tracking details.

Fields

Example

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

ShippingAddressInput

Defines a single shipping address.

Input Fields

Example

{
  "address": CartAddressInput,
  "customer_address_id": 123,
  "customer_address_uid": "4",
  "customer_notes": "abc123",
  "pickup_location_code": "abc123"
}

ShippingCartAddress

Contains shipping addresses and methods.

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "cart_items": [CartItemQuantity],
  "cart_items_v2": [CartItemInterface],
  "city": "xyz789",
  "company": "abc123",
  "country": CartAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "customer_notes": "xyz789",
  "fax": "xyz789",
  "firstname": "xyz789",
  "id": 123,
  "items_weight": 987.65,
  "lastname": "abc123",
  "middlename": "xyz789",
  "pickup_location_code": "xyz789",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": CartAddressRegion,
  "same_as_billing": true,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["xyz789"],
  "suffix": "abc123",
  "telephone": "xyz789",
  "uid": "4",
  "vat_id": "abc123"
}

ShippingDiscount

Defines an individual shipping discount. This discount can be applied to shipping.

Fields

Example

{"amount": Money}

ShippingHandling

Contains details about shipping and handling costs.

Fields

Example

{
  "amount_excluding_tax": Money,
  "amount_including_tax": Money,
  "discounts": [ShippingDiscount],
  "taxes": [TaxItem],
  "total_amount": Money
}

ShippingMethodInput

Defines the shipping carrier and method.

Input Fields

Example

{
  "carrier_code": "xyz789",
  "method_code": "xyz789"
}

SimpleCartItem

An implementation for simple product cart items.

Fields

Example

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