Types

KeyValue

Contains a key-value pair.

Fields

Example

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

LineItemNoteInput

Sets quote item note.

Input Fields

Example

{
  "note": "xyz789",
  "quote_item_uid": "4",
  "quote_uid": "4"
}

MediaGalleryInterface

Contains basic information about a product image or video.

Fields

Possible Types

Example

{
  "disabled": true,
  "label": "xyz789",
  "position": 123,
  "url": "xyz789"
}

MediaResourceType

Enumeration of media resource types

Values

Example

""NEGOTIABLE_QUOTE_ATTACHMENT""

MessageStyleLogo

Fields

Example

{"type": "xyz789"}

MessageStyles

Fields

Example

{
  "layout": "abc123",
  "logo": MessageStyleLogo
}

Money

Defines a monetary value, including a numeric value and a currency code.

Fields

Example

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

MoveCartItemsToGiftRegistryOutput

Contains the customer's gift registry and any errors encountered.

Fields

Example

{
  "gift_registry": GiftRegistry,
  "status": false,
  "user_errors": [GiftRegistryItemsUserError]
}

MoveItemsBetweenRequisitionListsInput

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

Input Fields

Example

{"requisitionListItemUids": [4]}

MoveItemsBetweenRequisitionListsOutput

Output of the request to move items to another requisition list.

Fields

Example

{
  "destination_requisition_list": RequisitionList,
  "source_requisition_list": RequisitionList
}

MoveLineItemToRequisitionListInput

Move Line Item to Requisition List.

Input Fields

Example

{
  "quote_item_uid": "4",
  "quote_uid": "4",
  "requisition_list_uid": "4"
}

MoveLineItemToRequisitionListOutput

Contains the updated negotiable quote.

Fields

Example

{"quote": NegotiableQuote}

MoveProductsBetweenWishlistsOutput

Contains the source and target wish lists after moving products.

Fields

Example

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

NegotiableQuote

Contains details about a negotiable quote.

Fields

Example

{
  "available_payment_methods": [AvailablePaymentMethod],
  "billing_address": NegotiableQuoteBillingAddress,
  "buyer": NegotiableQuoteUser,
  "comments": [NegotiableQuoteComment],
  "created_at": "xyz789",
  "custom_attributes": [CustomAttribute],
  "email": "abc123",
  "expiration_date": "xyz789",
  "history": [NegotiableQuoteHistoryEntry],
  "is_virtual": true,
  "items": [CartItemInterface],
  "name": "xyz789",
  "order": CustomerOrder,
  "prices": CartPrices,
  "sales_rep_name": "abc123",
  "selected_payment_method": SelectedPaymentMethod,
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "SUBMITTED",
  "template_id": 4,
  "template_name": "abc123",
  "total_quantity": 987.65,
  "uid": 4,
  "updated_at": "xyz789"
}

NegotiableQuoteAddressCountry

Defines the company's country.

Fields

Example

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

NegotiableQuoteAddressInput

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

Input Fields

Example

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

NegotiableQuoteAddressInterface

Fields

Possible Types

Example

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

NegotiableQuoteAddressRegion

Defines the company's state or province.

Fields

Example

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

NegotiableQuoteBillingAddress

Fields

Example

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

NegotiableQuoteBillingAddressInput

Defines the billing address.

Input Fields

Example

{
  "address": NegotiableQuoteAddressInput,
  "customer_address_uid": 4,
  "same_as_shipping": true,
  "use_for_shipping": false
}

NegotiableQuoteComment

Contains a single plain text comment from either the buyer or seller.

Fields

Example

{
  "attachments": [NegotiableQuoteCommentAttachment],
  "author": NegotiableQuoteUser,
  "created_at": "abc123",
  "creator_type": "BUYER",
  "text": "xyz789",
  "uid": 4
}

NegotiableQuoteCommentAttachment

Negotiable quote comment file attachment.

Fields

Example

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

NegotiableQuoteCommentAttachmentInput

Negotiable quote comment file attachment.

Input Fields

Example

{"key": "abc123"}

NegotiableQuoteCommentCreatorType

Values

Example

""BUYER""

NegotiableQuoteCommentInput

Contains the commend provided by the buyer.

Input Fields

Example

{
  "attachments": [NegotiableQuoteCommentAttachmentInput],
  "comment": "xyz789"
}

NegotiableQuoteCustomLogChange

Contains custom log entries added by third-party extensions.

Fields

Example

{
  "new_value": "abc123",
  "old_value": "abc123",
  "title": "xyz789"
}

NegotiableQuoteFilterInput

Defines a filter to limit the negotiable quotes to return.

Input Fields

Example

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

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": "xyz789",
  "item_note": HistoryItemNoteData,
  "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": "xyz789",
  "link_id": 4,
  "reference_document_url": "xyz789"
}

NegotiableQuoteShippingAddress

Fields

Example

{
  "available_shipping_methods": [AvailableShippingMethod],
  "city": "xyz789",
  "company": "abc123",
  "country": NegotiableQuoteAddressCountry,
  "custom_attributes": [AttributeValueInterface],
  "customer_address_uid": "4",
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "xyz789",
  "middlename": "abc123",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": NegotiableQuoteAddressRegion,
  "selected_shipping_method": SelectedShippingMethod,
  "street": ["abc123"],
  "suffix": "xyz789",
  "telephone": "xyz789",
  "uid": 4,
  "vat_id": "xyz789"
}

NegotiableQuoteShippingAddressInput

Defines shipping addresses for the negotiable quote.

Input Fields

Example

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

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],
  "created_at": "abc123",
  "expiration_date": "abc123",
  "history": [NegotiableQuoteHistoryEntry],
  "historyV2": [NegotiableQuoteTemplateHistoryEntry],
  "is_min_max_qty_used": false,
  "is_virtual": false,
  "items": [CartItemInterface],
  "max_order_commitment": 987,
  "min_order_commitment": 987,
  "name": "xyz789",
  "notifications": [QuoteTemplateNotificationMessage],
  "prices": CartPrices,
  "reference_document_links": [
    NegotiableQuoteReferenceDocumentLink
  ],
  "sales_rep_name": "abc123",
  "shipping_addresses": [NegotiableQuoteShippingAddress],
  "status": "xyz789",
  "template_id": "4",
  "total_quantity": 123.45,
  "uid": 4,
  "updated_at": "abc123"
}

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": "xyz789",
  "company_name": "xyz789",
  "created_at": "abc123",
  "expiration_date": "abc123",
  "is_min_max_qty_used": false,
  "last_ordered_at": "abc123",
  "last_shared_at": "xyz789",
  "max_order_commitment": 123,
  "min_negotiated_grand_total": 123.45,
  "min_order_commitment": 987,
  "name": "xyz789",
  "orders_placed": 987,
  "prices": CartPrices,
  "sales_rep_name": "xyz789",
  "state": "abc123",
  "status": "xyz789",
  "submitted_by": "abc123",
  "template_id": 4,
  "uid": "4",
  "updated_at": "xyz789"
}

NegotiableQuoteTemplateHistoryChanges

Contains a list of changes to a negotiable quote template.

Fields

Example

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

NegotiableQuoteTemplateHistoryEntry

Contains details about a change for a negotiable quote template.

Fields

Example

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

NegotiableQuoteTemplateHistoryStatusChange

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

Fields

Example

{
  "new_status": "xyz789",
  "old_status": "xyz789"
}

NegotiableQuoteTemplateHistoryStatusesChange

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

Fields

Example

{"changes": [NegotiableQuoteTemplateHistoryStatusChange]}

NegotiableQuoteTemplateItemQuantityInput

Specifies the updated quantity of an item.

Input Fields

Example

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

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

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

NegotiableQuotesOutput

Contains a list of negotiable that match the specified filter.

Fields

Example

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

NoSuchEntityUidError

Contains an error message when an invalid UID was specified.

Fields

Example

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

NumericOperatorInput

Input Fields

Example

{"type": "UNKNOWN_NUMERIC_OPERATOR"}

NumericOperatorType

Values

Example

""UNKNOWN_NUMERIC_OPERATOR""

OopePaymentMethodConfig

Fields

Example

{
  "backend_integration_url": "xyz789",
  "custom_config": [CustomConfigKeyValue]
}

OpenNegotiableQuoteTemplateInput

Specifies the quote template id to open quote template.

Input Fields

Example

{"template_id": "4"}

OperatorInput

Input Fields

Example

{
  "rangeOperator": RangeOperatorInput,
  "customOperator": CustomOperatorInput,
  "isOperator": IsOperatorInput,
  "numericOperator": NumericOperatorInput,
  "stringOperator": StringOperatorInput
}

Order

Contains the order ID.

Fields

Example

{"order_number": "abc123"}

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": "xyz789",
  "company": "xyz789",
  "country_code": "AF",
  "custom_attributesV2": [AttributeValueInterface],
  "fax": "abc123",
  "firstname": "abc123",
  "lastname": "abc123",
  "middlename": "xyz789",
  "postcode": "abc123",
  "prefix": "xyz789",
  "region": "abc123",
  "region_id": 4,
  "street": ["xyz789"],
  "suffix": "xyz789",
  "telephone": "abc123",
  "vat_id": "abc123"
}

OrderCustomerInfo

Fields

Example

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

OrderItem

Fields

Example

{
  "custom_attributes": [CustomAttribute],
  "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": 987.65,
  "quantity_invoiced": 123.45,
  "quantity_ordered": 123.45,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 987.65,
  "quantity_returned": 123.45,
  "quantity_shipped": 987.65,
  "selected_options": [OrderItemOption],
  "status": "xyz789"
}

OrderItemInterface

Order item details.

Fields

Possible Types

Example

{
  "custom_attributes": [CustomAttribute],
  "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": "abc123",
  "product_type": "abc123",
  "product_url_key": "abc123",
  "quantity_canceled": 123.45,
  "quantity_invoiced": 987.65,
  "quantity_ordered": 987.65,
  "quantity_refunded": 987.65,
  "quantity_return_requested": 123.45,
  "quantity_returned": 123.45,
  "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": "abc123"
}

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

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

PageType

Type of page on which recommendations are requested

Values

Example

""CMS""

PaymentAttributeInput

Defines the payment attribute.

Input Fields

Example

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

PaymentConfigItem

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

Fields

Possible Types

Example

{
  "code": "abc123",
  "is_visible": false,
  "payment_intent": "abc123",
  "sdk_params": [SDKParams],
  "sort_order": "xyz789",
  "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

{
  "additional_data": [PaymentAttributeInput],
  "code": "xyz789",
  "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,
  "purchase_order_number": "abc123"
}

PaymentOrderOutput

Contains the payment order details

Fields

Example

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

PaymentSDKParamsItem

Fields

Example

{
  "code": "xyz789",
  "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": "xyz789",
  "type": "card"
}

PaymentTokenTypeEnum

The list of available payment token types.

Values

Example

""card""

PhysicalProductInterface

Contains attributes specific to tangible products.

Fields

Possible Types

Example

{"weight": 123.45}

PickupLocation

Defines Pickup Location information.

Fields

Example

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

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

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}

PlaceNegotiableQuoteOrderOutputV2

An output object that returns the generated order.

Fields

Example

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

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

PlaceOrderOutput

Contains the results of the request to place an order.

Fields

Example

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

PlacePurchaseOrderInput

Specifies the quote to be converted to a purchase order.

Input Fields

Example

{"cart_id": "xyz789"}

PlacePurchaseOrderOutput

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

Fields

Example

{"purchase_order": PurchaseOrder}

Price

Defines the price of a simple product or a part of a price range for a complex product. It can include a list of price adjustments.

Fields

Example

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

PriceAdjustment

Specifies the amount and type of price adjustment.

Fields

Example

{"amount": 123.45, "code": "abc123"}

PriceDetails

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

Fields

Example

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

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

ProductAlertPriceInput

Input Fields

Example

{"sku": "xyz789"}

ProductAlertStockInput

Input Fields

Example

{"sku": "abc123"}

ProductAlertSubscriptionResult

Fields

Example

{"message": "abc123", "success": false}

ProductAttribute

Contains a product attribute code and value.

Fields

Example

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

ProductAttributeFile

Fields

Example

{
  "attribute_type": "xyz789",
  "code": 4,
  "url": "xyz789",
  "value": "abc123"
}

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}

ProductImage

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

Fields

Example

{
  "disabled": false,
  "label": "xyz789",
  "position": 123,
  "url": "abc123"
}

ProductImageThumbnail

Values

Example

""ITSELF""

ProductInfoInput

Product Information used for Pickup Locations search.

Input Fields

Example

{"sku": "abc123"}

ProductInterface

Contains fields that are common to all types of products.

Fields

Possible Types

Example

{
  "canonical_url": "xyz789",
  "categories": [CategoryInterface],
  "country_of_manufacture": "abc123",
  "crosssell_products": [ProductInterface],
  "custom_attributesV2": ProductCustomAttributes,
  "description": ComplexTextValue,
  "gift_message_available": false,
  "gift_wrapping_available": true,
  "gift_wrapping_price": Money,
  "image": ProductImage,
  "is_returnable": "xyz789",
  "manufacturer": 987,
  "max_sale_qty": 123.45,
  "media_gallery": [MediaGalleryInterface],
  "meta_description": "abc123",
  "meta_keyword": "xyz789",
  "meta_title": "abc123",
  "min_sale_qty": 123.45,
  "name": "xyz789",
  "new_from_date": "xyz789",
  "new_to_date": "abc123",
  "only_x_left_in_stock": 987.65,
  "options_container": "abc123",
  "price_range": PriceRange,
  "price_tiers": [TierPrice],
  "product_links": [ProductLinksInterface],
  "quantity": 123.45,
  "related_products": [ProductInterface],
  "short_description": ComplexTextValue,
  "sku": "xyz789",
  "small_image": ProductImage,
  "special_price": 987.65,
  "special_to_date": "abc123",
  "stock_status": "IN_STOCK",
  "swatch_image": "abc123",
  "thumbnail": ProductImage,
  "uid": 4,
  "upsell_products": [ProductInterface],
  "url_key": "xyz789"
}

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

ProductMediaGalleryEntriesAssetImage

Contains basic information about the image asset.

Fields

Example

{
  "asset_id": "abc123",
  "media_type": "xyz789",
  "media_url": "xyz789"
}

ProductMediaGalleryEntriesAssetVideo

Contains basic information about the video asset.

Fields

Example

{
  "media_type": "xyz789",
  "video_asset_id": "abc123",
  "video_media_url": "abc123"
}

ProductMediaGalleryEntriesVideoContent

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

Fields

Example

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

ProductPrice

Represents a product price.

Fields

Example

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

ProductSearchItem

A single product returned by the query

Fields

Example

{
  "applied_query_rule": AppliedQueryRule,
  "highlights": [Highlight],
  "productView": ProductView
}

ProductSearchResponse

Contains the output of a productSearch query

Fields

Example

{
  "facets": [Aggregation],
  "items": [ProductSearchItem],
  "page_info": SearchResultPageInfo,
  "related_terms": ["abc123"],
  "suggestions": ["abc123"],
  "total_count": 987,
  "warnings": [ProductSearchWarning]
}

ProductSearchSortInput

The product attribute to sort on

Input Fields

Example

{"attribute": "abc123", "direction": "ASC"}

ProductSearchWarning

Structured warning with code and message for easier client handling

Fields

Example

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

ProductStockStatus

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

Values

Example

""IN_STOCK""

ProductVideo

Contains information about a product video.

Fields

Example

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

ProductView

Defines the product fields available to the SimpleProductView and ComplexProductView types.

Fields

Possible Types

Example

{
  "addToCartAllowed": false,
  "inStock": true,
  "lowStock": false,
  "attributes": [ProductViewAttribute],
  "description": "abc123",
  "id": "4",
  "images": [ProductViewImage],
  "videos": [ProductViewVideo],
  "lastModifiedAt": "2007-12-03T10:15:30Z",
  "metaDescription": "abc123",
  "metaKeyword": "xyz789",
  "metaTitle": "xyz789",
  "name": "xyz789",
  "shortDescription": "xyz789",
  "inputOptions": [ProductViewInputOption],
  "sku": "abc123",
  "externalId": "abc123",
  "url": "xyz789",
  "urlKey": "abc123",
  "links": [ProductViewLink],
  "queryType": "abc123",
  "visibility": "abc123"
}

ProductViewAttribute

A container for customer-defined attributes that are displayed the storefront.

Fields

Example

{
  "label": "xyz789",
  "name": "abc123",
  "roles": ["abc123"],
  "value": {}
}

ProductViewCurrency

The list of supported currency codes.

Values

Example

""AED""

ProductViewImage

Contains details about a product image.

Fields

Example

{
  "label": "xyz789",
  "roles": ["xyz789"],
  "url": "abc123"
}

ProductViewInputOption

Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.

Fields

Example

{
  "id": "4",
  "title": "abc123",
  "required": false,
  "type": "xyz789",
  "markupAmount": 987.65,
  "suffix": "abc123",
  "sortOrder": 123,
  "range": ProductViewInputOptionRange,
  "imageSize": ProductViewInputOptionImageSize,
  "fileExtensions": "abc123"
}

ProductViewInputOptionImageSize

Dimensions of the image associated with the input option.

Fields

Example

{"width": 123, "height": 987}

ProductViewInputOptionRange

Lists the value range associated with a ProductViewInputOption. For example, if the input option is a text field, the range represents the number of characters.

Fields

Example

{"from": 987.65, "to": 123.45}

ProductViewLink

The product link type. Contains details about product links for related products and cross selling. For example, related, up_sell or cross_sell

Fields

Example

{
  "product": ProductView,
  "linkTypes": ["abc123"]
}

ProductViewMoney

Defines a monetary value, including a numeric value and a currency code.

Fields

Example

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

ProductViewOption

Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product.

Fields

Example

{
  "id": "4",
  "multi": true,
  "required": true,
  "title": "abc123",
  "values": [ProductViewOptionValue]
}

ProductViewOptionValue

Defines the product fields available to the ProductViewOptionValueProduct and ProductViewOptionValueConfiguration types.

Fields

Possible Types

Example

{
  "id": "4",
  "title": "xyz789",
  "inStock": true
}

ProductViewOptionValueConfiguration

An implementation of ProductViewOptionValue for configuration values.

Fields

Example

{
  "id": "4",
  "title": "abc123",
  "inStock": true
}

ProductViewOptionValueProduct

An implementation of ProductViewOptionValue that adds details about a simple product.

Fields

Example

{
  "id": "4",
  "isDefault": true,
  "product": SimpleProductView,
  "quantity": 123.45,
  "title": "abc123",
  "inStock": true
}

ProductViewOptionValueSwatch

An implementation of ProductViewOptionValueSwatch for swatches.

Fields

Example

{
  "id": "4",
  "title": "abc123",
  "type": "TEXT",
  "value": "abc123",
  "inStock": true
}

ProductViewPrice

Base product price view. Contains the final price after discounts, the regular price, and the list of tier prices.

Fields

Example

{
  "final": Price,
  "regular": Price,
  "tiers": [ProductViewTierPrice],
  "roles": ["xyz789"]
}

ProductViewPriceRange

The minimum and maximum price of a complex product.

Fields

Example

{
  "maximum": ProductViewPrice,
  "minimum": ProductViewPrice
}

ProductViewTierCondition

Types

Example

ProductViewTierRangeCondition

ProductViewTierExactMatchCondition

Minimum quantity (inclusive) required to activate this tier price. For example, a value of 10 means this tier applies when 10 or more items are purchased.

Fields

Example

{"in": [987.65]}

ProductViewTierPrice

The discounted price that applies when the quantity conditions in quantity are satisfied. Contains the monetary amount and any price adjustments applied to this tier.

Fields

Example

{
  "tier": Price,
  "quantity": [ProductViewTierRangeCondition]
}

ProductViewTierRangeCondition

Minimum quantity (inclusive) required to activate this tier price. For example, a value of 10 means this tier applies when 10 or more items are purchased. Maximum quantity (exclusive) required to activate this tier price. For example, a value of 20 means this tier applies when less than 20 items are purchased.

Fields

Example

{"gte": 123.45, "lt": 987.65}

ProductViewVariant

Represents a product variant.

Fields

Example

{
  "selections": ["xyz789"],
  "product": ProductView
}

ProductViewVariantResults

Represents the results of a product variant search.

Fields

Example

{
  "variants": [ProductViewVariant],
  "cursor": "abc123"
}

ProductViewVideo

Contains details about a product video. For example, a video of the product being used or a video of the product being assembled.

Fields

Example

{
  "preview": ProductViewImage,
  "url": "xyz789",
  "description": "xyz789",
  "title": "abc123"
}

PurchaseHistory

User purchase history

Input Fields

Example

{
  "date": "2007-12-03T10:15:30Z",
  "items": ["abc123"]
}

PurchaseOrder

Contains details about a purchase order.

Fields

Example

{
  "approval_flow": [PurchaseOrderRuleApprovalFlow],
  "available_actions": ["REJECT"],
  "comments": [PurchaseOrderComment],
  "created_at": "xyz789",
  "created_by": Customer,
  "history_log": [PurchaseOrderHistoryItem],
  "number": "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": "abc123",
  "name": "abc123",
  "role": "xyz789",
  "status": "PENDING",
  "updated_at": "abc123"
}

PurchaseOrderApprovalFlowItemStatus

Values

Example

""PENDING""

PurchaseOrderApprovalRule

Contains details about a purchase order approval rule.

Fields

Example

{
  "applies_to_roles": [CompanyRole],
  "approver_roles": [CompanyRole],
  "condition": PurchaseOrderApprovalRuleConditionInterface,
  "created_at": "abc123",
  "created_by": "abc123",
  "description": "abc123",
  "name": "abc123",
  "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": "abc123",
  "name": "abc123",
  "status": "ENABLED"
}

PurchaseOrderApprovalRuleMetadata

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

Fields

Example

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

PurchaseOrderApprovalRuleStatus

Values

Example

""ENABLED""

PurchaseOrderApprovalRuleType

Values

Example

""GRAND_TOTAL""

PurchaseOrderApprovalRules

Contains the approval rules that the customer can see.

Fields

Example

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

PurchaseOrderComment

Contains details about a comment.

Fields

Example

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

PurchaseOrderErrorType

Values

Example

""NOT_FOUND""

PurchaseOrderHistoryItem

Contains details about a status change.

Fields

Example

{
  "activity": "xyz789",
  "created_at": "abc123",
  "message": "abc123",
  "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,
  "my_approvals": true,
  "require_my_approval": true,
  "status": "PENDING"
}