The following sections describe all changes made to OCAPI since version 16.5.
Document Name | Change | API | Details |
---|---|---|---|
ActivityRequest | Added | Shop API | N/A |
ActivityResult | Added | Shop API | N/A |
AddressLink | Removed | Shop API | N/A |
AiProduct | Added | Shop API | N/A |
ApplicationPermissions | Added | Data API | N/A |
ApproachingDiscount | Added | Shop API | N/A |
ApproachingDiscountResult | Added | Shop API | N/A |
BMPermissions | Added | Data API | N/A |
Basket | Changed | Shop API | More |
BasketReference | Added | Shop API | N/A |
BonusDiscountLineItem | Added | Shop API | N/A |
CSCPermissions | Added | Data API | N/A |
Campaign | Changed | Data API | More |
CampaignPromotionExperience | Added | Data API | N/A |
CampaignSlotConfigurationExperience | Added | Data API | N/A |
CampaignSortingRuleExperience | Added | Data API | N/A |
Campaigns | Added | Data API | N/A |
CartridgePathAddRequest | Added | Data API | N/A |
CartridgePathApiResponse | Added | Data API | N/A |
CartridgePathCreateRequest | Added | Data API | N/A |
Catalog | Changed | Data API | More |
CatalogCategoryId | Added | Data API | N/A |
Categories | Added | Data API | N/A |
Category | Changed | Data API | More |
CategoryLink | Added | Data API | N/A |
CategoryLinks | Added | Data API | N/A |
CodeVersion | Changed | Data API | More |
ContentAsset | Changed | Data API | More |
ContentFolder | Changed | Data API | More |
Coupon | Changed | Data API | More |
CouponRedemption | Added | Data API | N/A |
CouponRedemptionSearchResult | Added | Data API | N/A |
Coupons | Added | Data API | N/A |
Customer | Changed | Data API | More |
Customer | Changed | Shop API | More |
CustomerAddress | Changed | Data API | More |
CustomerAddress | Changed | Shop API | More |
CustomerAddressLink | Added | Shop API | N/A |
CustomerGroup | Changed | Data API | More |
CustomerGroupMember | Changed | Data API | More |
CustomerGroupMembers | Added | Data API | N/A |
CustomerPaymentCardRequest | Changed | Shop API | More |
CustomerPaymentInstrument | Changed | Shop API | More |
CustomerProductList | Added | Shop API | N/A |
CustomerProductListItem | Added | Shop API | N/A |
CustomerProductListItemLink | Added | Shop API | N/A |
CustomerProductListItemPurchase | Added | Shop API | N/A |
CustomerProductListItemPurchaseResult | Added | Shop API | N/A |
CustomerProductListItemResult | Added | Shop API | N/A |
CustomerProductListRegistrant | Added | Shop API | N/A |
CustomerProductListResult | Added | Shop API | N/A |
CustomerSearchHit | Added | Data API | N/A |
CustomerSearchHit | Changed | Data API | More |
CustomerSearchRequest | Changed | Data API | More |
CustomerSearchResult | Changed | Data API | More |
CustomerSearchResult | Added | Data API | N/A |
EcdnLogFetchRequest | Added | Data API | N/A |
EcdnLogFetchResponse | Added | Data API | N/A |
ExportDataUnitsConfiguration | Added | Data API | N/A |
ExportGlobalDataConfiguration | Added | Data API | N/A |
ExportSitesConfiguration | Added | Data API | N/A |
FunctionalPermission | Added | Data API | N/A |
FunctionalPermissions | Added | Data API | N/A |
GiftCertificate | Changed | Data API | More |
GiftCertificates | Added | Data API | N/A |
Image | Removed | Data API | N/A |
ImageGroup | Added | Data API | N/A |
InventoryList | Changed | Data API | More |
InventoryLists | Added | Data API | N/A |
JobExecution | Added | Data API | N/A |
JobExecutionParameter | Added | Data API | N/A |
JobExecutionRequest | Added | Data API | N/A |
JobExecutionResult | Added | Data API | N/A |
JobExecutionSearchResult | Added | Data API | N/A |
JobStepExecution | Added | Data API | N/A |
Locale | Added | Data API | N/A |
Locale | Added | Shop API | N/A |
LocalePermission | Added | Data API | N/A |
LocalePermissions | Added | Data API | N/A |
LocaleResult | Added | Data API | N/A |
MarkupText | Added | Data API | N/A |
MediaFile | Added | Data API | N/A |
MenuAction | Added | Data API | N/A |
MenuItem | Added | Data API | N/A |
ModulePermissions | Added | Data API | N/A |
ObjectAttributeDefinition | Added | Data API | N/A |
ObjectAttributeDefinitionSearchResult | Added | Data API | N/A |
ObjectAttributeDefinitions | Added | Data API | N/A |
ObjectAttributeGroup | Added | Data API | N/A |
ObjectAttributeGroupSearchResult | Added | Data API | N/A |
ObjectAttributeGroups | Added | Data API | N/A |
ObjectAttributeValueDefinition | Added | Data API | N/A |
ObjectTypeDefinition | Added | Data API | N/A |
ObjectTypeDefinitionSearchResult | Added | Data API | N/A |
ObjectTypeDefinitions | Added | Data API | N/A |
OptionItem | Changed | Shop API | More |
Order | Changed | Shop API | More |
OrderPaymentCardRequest | Changed | Shop API | More |
OrderPaymentInstrument | Changed | Shop API | More |
OrderSearchHit | Changed | Shop API | More |
OrderSearchRequest | Changed | Shop API | More |
OrderSearchResult | Changed | Shop API | More |
OrganizationPreferences | Added | Data API | N/A |
PasswordChangeRequest | Added | Data API | N/A |
PaymentMethod | Changed | Shop API | More |
PreferenceValue | Added | Data API | N/A |
PreferenceValueSearchResult | Added | Data API | N/A |
PriceAdjustment | Changed | Shop API | More |
PriceAdjustmentLimit | Added | Shop API | N/A |
PriceAdjustmentLimits | Added | Shop API | N/A |
Product | Changed | Data API | More |
Product | Changed | Shop API | More |
ProductInventoryRecord | Changed | Data API | More |
ProductItem | Changed | Shop API | More |
ProductList | Removed | Shop API | N/A |
ProductListEvent | Removed | Shop API | N/A |
ProductListEvent | Added | Shop API | N/A |
ProductListItemLink | Removed | Shop API | N/A |
ProductListItemResult | Removed | Shop API | N/A |
ProductListRegistrant | Added | Shop API | N/A |
ProductListRegistrant | Removed | Shop API | N/A |
ProductListResult | Removed | Shop API | N/A |
ProductListShippingAddress | Removed | Shop API | N/A |
ProductListShippingAddress | Added | Shop API | N/A |
ProductOption | Added | Data API | N/A |
ProductOptionValue | Added | Data API | N/A |
ProductOptionValues | Added | Data API | N/A |
ProductOptions | Added | Data API | N/A |
ProductRecommendationsResult | Added | Shop API | N/A |
ProductRef | Added | Shop API | N/A |
ProductSearchHit | Changed | Shop API | More |
ProductSearchResult | Changed | Shop API | More |
ProductSimpleLink | Added | Shop API | N/A |
Promotion | Added | Data API | N/A |
PromotionABTestGroupAssignment | Added | Data API | N/A |
PromotionAssignmentInformation | Added | Data API | N/A |
PromotionCampaignAssignment | Added | Data API | N/A |
PromotionCampaignAssignmentSearchResult | Added | Data API | N/A |
PromotionLink | Added | Shop API | N/A |
PromotionSearchResult | Added | Data API | N/A |
Promotions | Added | Data API | N/A |
PublicProductList | Added | Shop API | N/A |
PublicProductListItem | Added | Shop API | N/A |
PublicProductListItemResult | Added | Shop API | N/A |
PublicProductListLink | Added | Shop API | N/A |
PublicProductListResult | Added | Shop API | N/A |
Recommender | Added | Data API | N/A |
RecommendersResult | Added | Data API | N/A |
Role | Added | Data API | N/A |
RoleFunctionalPermission | Added | Data API | N/A |
RoleFunctionalPermissions | Added | Data API | N/A |
RoleLocalePermission | Added | Data API | N/A |
RoleLocalePermissions | Added | Data API | N/A |
RoleModulePermission | Added | Data API | N/A |
RoleModulePermissions | Added | Data API | N/A |
RolePermissions | Added | Data API | N/A |
RoleSearchResult | Added | Data API | N/A |
RoleWebdavPermission | Added | Data API | N/A |
RoleWebdavPermissions | Added | Data API | N/A |
Roles | Added | Data API | N/A |
ShippingMethod | Changed | Shop API | More |
Site | Changed | Data API | More |
Site | Changed | Shop API | More |
SiteArchiveExportConfiguration | Added | Data API | N/A |
SiteArchiveImportConfiguration | Added | Data API | N/A |
SitePreferences | Added | Data API | N/A |
SiteSearchResult | Added | Data API | N/A |
Sites | Added | Data API | N/A |
SlotConfiguration | Changed | Data API | More |
SlotConfigurationABTestGroupAssignment | Added | Data API | N/A |
SlotConfigurationAssignmentInformation | Added | Data API | N/A |
SlotConfigurationCampaignAssignment | Added | Data API | N/A |
SlotConfigurationCampaignAssignmentSearchResult | Added | Data API | N/A |
SlotConfigurations | Added | Data API | N/A |
SlotContent | Changed | Data API | More |
SlotSearchResult | Added | Data API | N/A |
Slots | Added | Data API | N/A |
SourceCodeGroup | Added | Data API | N/A |
SourceCodeGroupSearchResult | Added | Data API | N/A |
SourceCodeGroups | Added | Data API | N/A |
SourceCodeRedirectInfo | Added | Data API | N/A |
SourceCodeSpecification | Added | Data API | N/A |
Status | Added | Data API | N/A |
Status | Added | Shop API | N/A |
Store | Changed | Data API | More |
Store | Changed | Shop API | More |
Stores | Added | Data API | N/A |
SuggestedPhrase | Added | Shop API | N/A |
SuggestedTerm | Added | Shop API | N/A |
SuggestedTerms | Added | Shop API | N/A |
Suggestion | Changed | Shop API | More |
SuggestionResult | Changed | Shop API | More |
Tag | Added | Data API | N/A |
User | Added | Data API | N/A |
UserSearchResult | Added | Data API | N/A |
Users | Added | Data API | N/A |
Variant | Changed | Data API | More |
VariantSearchResult | Added | Data API | N/A |
Variants | Added | Data API | N/A |
VariationAttribute | Changed | Data API | More |
VariationAttributeValue | Changed | Data API | More |
VariationAttributeValues | Added | Data API | N/A |
VariationAttributes | Added | Data API | N/A |
VariationGroups | Added | Data API | N/A |
WebdavPermission | Added | Data API | N/A |
WebdavPermissions | Added | Data API | N/A |
The following requests have been modified since 16.5.
PATCH /baskets/{basket_id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Description | Changed | Shop | Updates a basket. Only the currency of the basket and the custom properties of the basket and of the shipping items will be considered. | Updates a basket. Only the currency of the basket, source code, and the custom properties of the basket and of the shipping items will be considered. |
Fault | Added | Shop | N/A | SourceCodeNotFoundException(404): Indicates that the provided code was not found. sourceCode (String) |
Fault | Added | Shop | N/A | SourceCodeInactiveException(400): Indicates that the provided code is not currently active. sourceCode (String) |
POST /baskets/{basket_id}/items
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Title | Changed | Shop | Add item to a basket | Add items to a basket |
Description | Changed | Shop | Adds a new item to a basket.
The added item is associated with the
specified shipment. If no shipment id is specified, the added
item is associated with the default shipment.
Considered values from the request body
are:
|
Adds new items to a basket.
The added items are associated with the
specified shipment. If no shipment id is specified, the added
items are associated with the default shipment.
Considered values from the request body,
for each item are:
|
Fault | Added | Shop | N/A | BonusDiscountLineItemNotFoundException(400): Indicates that the provided bonus discount line item id is not present in the current basket. bonusDiscountLineItemId (String) |
Fault | Added | Shop | N/A | InvalidBonusProductException(400): Indicates that the selected bonus product is not an applicable product for the bonus discount line item provided. productId (String) bonusDiscountLineItemId (String) |
Fault | Added | Shop | N/A | BonusProductQuantityException(400): Indicates that the quantity of the product to be added will result in the number of selected bonus choice products to exceed the amount that the user is permitted to select. bonusDiscountLineItemId (String) |
PUT /sites/{site_id}/campaigns/{campaign_id}/slot_configurations/{slot_id}/{slot_config_id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Title | Changed | Data | Bind SlotConfiguration | Bind Slot Configuration to Campaign |
Body | Changed | Data | None | SlotConfigurationCampaignAssignment |
Path Parameter | Changed | Data | Name: campaign_id Description: The id of the campaign |
Name: campaign_id Description: The ID of the campaign. |
Path Parameter | Changed | Data | Name: site_id Description: The id of the site |
Name: site_id Description: The ID of the site. |
Path Parameter | Changed | Data | Name: slot_id Description: The of the slot |
Name: slot_id Description: The ID of the slot. |
Path Parameter | Changed | Data | Name: slot_config_id Description: The id of the slot configuration |
Name: slot_config_id Description: The ID of the slot configuration. |
Fault | Added | Data | N/A | IdConflictException(400): Indicates the ID in the URL does not match the ID in the request bodyID (String) urlID (String) |
GET /categories/({id},...,{id})
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Description | Changed | Shop | When you use the URL template below, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify multiple ids (up to a maximum of 50). You must enclose the list of ids in parentheses. If a category identifier contains a parenthesis or the separator sign, you must URL encode the character. Please note, using a large value for levels parameter may cause performance issues in case of a large and deep category tree. The server only returns online categories. | When you use the URL template below, the server returns multiple categories (a result object of category documents). You can use this template as a convenient way of obtaining multiple categories in a single request, instead of issuing separate requests for each category. You can specify multiple ids (up to a maximum of 50). You must enclose the list of ids in parentheses. If a category identifier contains a parenthesis or the separator sign, you must URL encode the character. The server only returns online categories. |
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
Query Parameter | Changed | Shop | Name: levels Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1. |
Name: levels Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. |
GET /categories/{id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Description | Changed | Shop | When you use the URL template below, the server returns a category identified by its id; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. Please note, using a large value for levels may cause performance issues in case of a large and deep category tree. The server only returns online categories. | When you use the URL template below, the server returns a category identified by its id; by default, the server also returns the first level of subcategories, but you can specify another level by setting the levels parameter. The server only returns online categories. |
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
Query Parameter | Changed | Shop | Name: levels Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1. |
Name: levels Description: Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. |
GET /content/({id},...,{id})
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /content/{id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /content_search
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /custom_objects/{object_type}/{key}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /customers/{customer_id}/orders
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Path Parameter | Changed | Shop | Name: customer_id Description: the customer UUID |
Name: customer_id Description: the customer uuid |
Query Parameter | Added | Shop | N/A | Name: from Type: String Description: The from date specifying the date time range to filter orders (inclusive, null allowed, ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ). Constraints: |
Query Parameter | Added | Shop | N/A | Name: until Type: String Description: The until date specifying the date time range to filter orders (inclusive, null allowed, ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ). Constraints: |
Query Parameter | Added | Shop | N/A | Name: status Type: String Description: The order status of the orders to be retrieved. Status included: created, new, open, completed, cancelled, replaced, failed. Constraints: |
Fault | Added | Shop | N/A | InvalidOrderStatusException(400): Thrown if specified status is unknown. status (String) |
GET /customers/{customer_id}/payment_instruments/{payment_instrument_id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Path Parameter | Changed | Shop | Name: payment_instrument_id Description: the id of the payment instrument to be retrieved |
Name: payment_instrument_id Description: the id of the payment instrument to be retrievedCustomer |
Fault | Removed | Shop | InvalidCustomerException(400): Indicates that the customerId URL parameter does not match the verified customer represented by the JWT token, not relevant when using OAuth. |
N/A |
GET /folders/({id},...,{id})
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /folders/{id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
POST /order_search
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Description | Changed | Shop | Searches for orders performing full text search.
The
search is configured by providing a search phrase and search
fields (optional). If search fields are not provided, the
default ones are used (order_no). The search retrieves orders
having each one word of the search phrase in any of the search
fields.
Additionally the retrieved orders could be limited
by "query" and "query_args" parameters.
Note that full text
order search always uses Search Service and the following
limitations exist:
|
Searches for orders.
The query attribute specifies a
complex query that can be used to narrow down the search.
Note that search fields are mandatory now and no default ones
are supported.
As the old order search version, the new one
always uses Search Service too and the for that reason Order
Incremental Indexing should be enabled. Otherwise HTTP 500
response will occur.
The supported search fields are:
|
Fault | Removed | Shop | OrderSearchIndexingDisabledException(400): Thrown when Incremental Indexing is not enabled for Order search schema. |
N/A |
POST /orders/{order_no}/payment_instruments
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Query Parameter | Added | Shop | N/A | Name: skip_authorization Type: Boolean Description: Constraints: |
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Query Parameter | Added | Shop | N/A | Name: skip_authorization Type: Boolean Description: Constraints: |
GET /product_lists
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Secure Flag | Changed | Shop | false | true |
Description | Changed | Shop | Retrieves a list of all product lists as defined by the given search term (hence email, firstname, lastname). If no search term is given all owned product lists will be retrieved. | Retrieves all public product lists as defined by the given search term (email, first name, last name). |
Authentication | Added | Shop | N/A | None: No authentication. |
Response | Changed | Shop | ProductListResult | PublicProductListResult |
Query Parameter | Changed | Shop | Name: email Description: email address of the customer, the product lists belong to |
Name: email Description: The email address of the customer, the product lists belong to. |
Query Parameter | Changed | Shop | Name: firstname Description: first name of the customer, the product lists belong to |
Name: firstname Description: The first name of the customer, the product lists belong to. |
Query Parameter | Changed | Shop | Name: lastname Description: last name of the customer, the product lists belong to |
Name: lastname Description: The last name of the customer, the product lists belong to. |
Fault | Removed | Shop | CustomerNotAuthenticatedException(401): Indicates that the customer is not authenticated and must be logged in. |
N/A |
Fault | Changed | Shop | ProductListSearchTermException(400): Indicates that the anonymous customer did not provide a proper search term. |
ProductListSearchTermException(400): Indicates that the anonymous customer did not provide a proper search term. |
GET /product_lists/{list_id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Secure Flag | Changed | Shop | false | true |
Description | Changed | Shop | Retrieves a product list by id. | Retrieves a public product list by id. |
Authentication | Added | Shop | N/A | None: No authentication. |
Response | Changed | Shop | ProductList | PublicProductList |
Path Parameter | Changed | Shop | Name: list_id Description: id of the list |
Name: list_id Description: The id of the list. |
Query Parameter | Added | Shop | N/A | Name: expand Type: [String] Description: The possible expansions - items, product, images, availability. The product information is included in the product list items that is why the product expansion has to be done together with items expansion. For images and availability both product and items have to be expanded as well. Constraints: |
Fault | Removed | Shop | CustomerNotAuthenticatedException(401): Indicates that the customer is not authenticated and must be logged in. |
N/A |
Fault | Removed | Shop | CustomerNotAuthorizedException(403): Indicates that the authenticated customer is not the owner of the list |
N/A |
Fault | Changed | Shop | ProductListNotFoundException(404): Indicates that this list doesn't exist productListId (String) |
ProductListNotFoundException(404): Indicates that this list doesn't exist. productListId (String) |
GET /product_lists/{list_id}/items
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Secure Flag | Changed | Shop | false | true |
Description | Changed | Shop | Retrieves a product list's items. | Retrieves the items of a public product list. |
Authentication | Added | Shop | N/A | None: No authentication. |
Response | Changed | Shop | ProductListItemResult | PublicProductListItemResult |
Path Parameter | Changed | Shop | Name: list_id Description: id of the list |
Name: list_id Description: The id of the list. |
Query Parameter | Added | Shop | N/A | Name: expand Type: [String] Description: The possible expansions - product, images, availability. For images and availability the product has to be expanded as well. Constraints: |
Fault | Removed | Shop | CustomerNotAuthenticatedException(401): Indicates that the customer is not authenticated and must be logged in. |
N/A |
Fault | Removed | Shop | CustomerNotAuthorizedException(403): Indicates that the authenticated customer is not the owner of the list |
N/A |
Fault | Changed | Shop | ProductListNotFoundException(404): Indicates that this list doesn't exist productListId (String) |
ProductListNotFoundException(404): Indicates that this list doesn't exist. productListId (String) |
GET /product_search
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
Query Parameter | Changed | Shop | Name: refine Description: Parameter that
represents a refinement attribute/value(s) pair. Refinement
attribute id and value(s) are separated by '='. Multiple values
are supported by a sub-set of refinement attributes and can be
provided by separating them using a pipe (URL encoded = "|").
Value ranges can be specified like this: refine=price=(100..500)
Multiple refine parameters can be provided by adding an
underscore in combination with an integer counter right behind
the parameter name and a counter range 1..9. I.e.
refine_1=c_refinementColor=red|green|blue. The following system
refinement attribute ids are supported:
|
Name: refine Description: Parameter that
represents a refinement attribute/value(s) pair. Refinement
attribute id and value(s) are separated by '='. Multiple values
are supported by a sub-set of refinement attributes and can be
provided by separating them using a pipe (URL encoded = "|").
Value ranges can be specified like this: refine=price=(100..500)
Multiple refine parameters can be provided by adding an
underscore in combination with an integer counter right behind
the parameter name and a counter range 1..9. I.e.
refine_1=c_refinementColor=red|green|blue. The following system
refinement attribute ids are supported:
|
Query Parameter | Changed | Shop | Name: expand Description: The expand parameter. A comma separated list with the allowed values (availability, images, prices, variations) |
Name: expand Description: The expand parameter. A comma separated list with the allowed values (availability, images, prices, represented_products, variations) |
GET /product_search/availability
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /product_search/images
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /product_search/prices
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /product_search/variations
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Query Parameter | Changed | Data | Name: expand Description: The list of expansions that can be applied to the product. They are:
Note that only variants with variation values are retrieved for a product of type variation master. |
Name: expand Description: The list of expansions that can be applied to the product. They are:
Note that only variants with variation values are retrieved for a product of type variation master. |
GET /products/({id},...,{id})
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
Query Parameter | Added | Shop | N/A | Name: all_images Type: Boolean Description: The flag that indicates whether to retrieve the whole image model for the requested product. Constraints: |
GET /products/{id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
Query Parameter | Added | Shop | N/A | Name: all_images Type: Boolean Description: The flag that indicates whether to retrieve the whole image model for the requested product. Constraints: |
GET /products/{id}/availability
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/bundled_products
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/images
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/links
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/options
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/prices
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/promotions
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/recommendations
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/set_products
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /products/{id}/variations
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /promotions
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /promotions/({id},...,{id})
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /promotions/{id}
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /search_suggestion
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /site
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /stores
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /stores/({id},...,{id})
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT token. |
GET /stores/{id}
The following documents have been modified since 16.5.
Basket
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: bonus_discount_line_items Type: [BonusDiscountLineItem] Description: The bonus discount line items of the line item container. Constraints: |
Property | Added | Shop | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Shop | N/A | Name: inventory_reservation_expiry Type: Date Description: Constraints: |
Property | Added | Shop | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Added | Shop | N/A | Name: source_code Type: String Description: Gets the source code assigned to this basket. Constraints: |
Campaign
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Catalog
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Changed | Data | Name: creation_date Type: DateTime Description: The creation date of catalog. It is read only. |
Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. |
Category
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Changed | Data | Name: creation_date Type: DateTime Description: The date when the category is created. This is a computed attribute and cannot be modified. |
Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. |
CodeVersion
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Removed | Data | Name: creation_time Type: DateTime Description: The code version creation time. Constraints: |
N/A |
ContentAsset
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
ContentFolder
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Coupon
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Customer
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Added | Data | N/A | Name: primary_address Type: CustomerAddress Description: The customers primary or default address. Constraints: |
Property | Changed | Data | Name: creation_date Description: The date when the customer was first created in the system. |
Name: creation_date Description: Returns the value of attribute 'creationDate'. |
Customer
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Added | Shop | N/A | Name: note Type: String Description: The customer's note. Constraints: |
Property | Changed | Shop | Name: creation_date Description: The customer's creation date. |
Name: creation_date Description: Returns the value of attribute 'creationDate'. |
CustomerAddress
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
CustomerAddress
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Shop | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
CustomerGroup
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
CustomerGroupMember
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
CustomerPaymentCardRequest
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Changed | Shop | Name: credit_card_expired Description: |
Name: credit_card_expired Description: A flag indicating if the credit card is expired. |
CustomerPaymentInstrument
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Shop | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
CustomerSearchHit
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: primary_address Type: CustomerAddress Description: The primary address for the customer. Constraints: |
CustomerSearchRequest
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: expand Type: [String] Description: The list of expands set for the search request. Expands are optional. Constraints: |
CustomerSearchResult
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: expand Type: [String] Description: The list of expands set. Can be empty. Constraints: |
GiftCertificate
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Changed | Data | Name: creation_date Type: DateTime Description: The creation date of the gift certificate. |
Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. |
InventoryList
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
OptionItem
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: bonus_discount_line_item_id Type: String Description: The id of the bonus discount line item this bonus product relates to. Constraints: |
Property | Added | Shop | N/A | Name: gift Type: boolean Description: Returns true if the item is a gift. Constraints: |
Property | Added | Shop | N/A | Name: gift_message Type: String Description: The gift message. Constraints: |
Order
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: bonus_discount_line_items Type: [BonusDiscountLineItem] Description: The bonus discount line items of the line item container. Constraints: |
Property | Added | Shop | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Added | Shop | N/A | Name: source_code Type: String Description: Gets the source code assigned to this basket. Constraints: |
Property | Changed | Shop | Name: creation_date Type: DateTime Description: The order creation date. This property follows the ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ. The time zone of the date time is always UTC. |
Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. |
OrderPaymentCardRequest
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Changed | Shop | Name: credit_card_expired Description: |
Name: credit_card_expired Description: A flag indicating if the credit card is expired. |
OrderPaymentInstrument
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: authorization_status Type: Status Description: The authorization status of the payment transaction. Constraints: |
Property | Removed | Shop | Name: etag Type: String Description: The etag to show the last update status. Constraints: |
N/A |
OrderSearchHit
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Changed | Shop | Name: relevance Type: double |
Name: relevance Type: Double |
OrderSearchRequest
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Description | Changed | Shop | Document representing an order full text search request. | Document representing an order search request. |
Property | Added | Shop | N/A | Name: db_start_record_ Type: Integer Description: The zero-based index of the record that we want to start with, used to optimize special handling Constraints: minIntegerValue=0 |
Property | Added | Shop | N/A | Name: expand Type: [String] Description: List of expansions to be applied to each search results. Expands are optional Constraints: |
Property | Added | Shop | N/A | Name: sorts Type: [Sort] Description: The list of sort clauses configured for the search request. Sort clauses are optional. Constraints: |
Property | Removed | Shop | Name: query_args Type: [String] Description: The query arguments. Constraints: |
N/A |
Property | Removed | Shop | Name: search_fields Type: [String] Description: The search fields to be used in case of full text search. If the list is null or empty the default search fields will be used. Constraints: |
N/A |
Property | Removed | Shop | Name: search_phrase Type: String Description: The search phrase. Constraints: |
N/A |
Property | Removed | Shop | Name: sort_fields Type: [SortField] Description: The sort fields list. Constraints: |
N/A |
Property | Changed | Shop | Name: count Description: The requested count parameter value. |
Name: count Description: The number of returned documents |
Property | Changed | Shop | Name: query Type: String Description: The requested query string which limits the results in addition to the search phrase. Constraints: |
Name: query Type: Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery} Description: The query to apply Constraints: mandatory=true, nullable=false |
Property | Changed | Shop | Name: select Description: The select parameter used to configure the search result document. See "API Usage > Property selection" for more information how to define a property selector. |
Name: select Description: The field to be selected. |
Property | Changed | Shop | Name: start Description: The requested start parameter value. |
Name: start Description: The zero-based index of the first search hit to include in the result. |
OrderSearchResult
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: db_start_record_ Type: Integer Description: The zero-based index of the record that we want to start with, used to optimize special handling Constraints: minIntegerValue=0 |
Property | Added | Shop | N/A | Name: expand Type: [String] Description: List of expansions to be applied to each search results. Expands are optional Constraints: |
Property | Added | Shop | N/A | Name: sorts Type: [Sort] Description: The list of sort clauses configured for the search request. Sort clauses are optional. Constraints: |
Property | Removed | Shop | Name: query_args Type: [String] Description: The query arguments. Constraints: |
N/A |
Property | Removed | Shop | Name: sort_string Type: String Description: The sort string. Constraints: |
N/A |
Property | Changed | Shop | Name: query Type: String Description: The requested query string. |
Name: query Type: Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery} Description: The query passed into the search |
PaymentMethod
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: payment_processor_id Type: String Description: The payment processor ID. Constraints: |
PriceAdjustment
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Changed | Shop | Name: creation_date Description: The creation date |
Name: creation_date Description: Returns the value of attribute 'creationDate'. |
Product
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: assigned_categories Type: [CatalogCategoryId] Description: The catalog categories that the product is assigned to Constraints: |
Property | Added | Data | N/A | Name: bundled_products Type: [Product] Description: The array of bundled products which the product includes. Constraints: |
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: image_groups Type: [ImageGroup] Description: The array of product image groups. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Added | Data | N/A | Name: product_bundles Type: [Product] Description: The array of product bundles which the product belongs to. Constraints: |
Property | Added | Data | N/A | Name: product_options Type: [ProductOption] Description: The array of product options. This is applicable for products of type "option". Constraints: |
Property | Added | Data | N/A | Name: product_sets Type: [Product] Description: The array of product sets which the product belongs to. Constraints: |
Property | Added | Data | N/A | Name: set_products Type: [Product] Description: The array of set products which the product includes. Constraints: |
Property | Changed | Data | Name: image Type: Image |
Name: image Type: MediaFile |
Property | Changed | Data | Name: long_description Type: [String] Description: The localized product long description. |
Name: long_description Type: [MarkupText] Description: The localized long description of the product. |
Property | Changed | Data | Name: short_description Type: [String] Description: The localized product short description. |
Name: short_description Type: [MarkupText] Description: The localized short description of the product. |
Product
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: valid_from Type: [DateTime] Description: The time when product is valid from. Constraints: |
Property | Added | Shop | N/A | Name: valid_to Type: [DateTime] Description: The time when product is valid to. Constraints: |
ProductInventoryRecord
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
ProductItem
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: bonus_discount_line_item_id Type: String Description: The id of the bonus discount line item this bonus product relates to. Constraints: |
Property | Added | Shop | N/A | Name: gift Type: boolean Description: Returns true if the item is a gift. Constraints: |
Property | Added | Shop | N/A | Name: gift_message Type: String Description: The gift message. Constraints: |
ProductSearchHit
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: hit_type Type: String Description: The type information for the search hit. Constraints: |
Property | Added | Shop | N/A | Name: represented_product Type: ProductRef Description: The first represented product. Constraints: |
Property | Added | Shop | N/A | Name: represented_products Type: [ProductRef] Description: All the represented products. Constraints: |
ProductSearchResult
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: search_phrase_suggestions Type: Suggestion Description: The suggestion given by the system for the submitted search phrase. Constraints: |
Property | Removed | Shop | Name: suggested_search_phrase Type: String Description: The suggestion given by the system if no result was found for the submitted search phrase. Constraints: |
N/A |
ShippingMethod
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: external_shipping_method Type: String Description: The external shipping method. Constraints: |
Site
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: cartridges Type: String Description: The cartridge Path of the site Constraints: |
Property | Added | Data | N/A | Name: description Type: [String] Description: The description of this site. Constraints: |
Property | Added | Data | N/A | Name: display_name Type: [String] Description: The display name entered by the user. Constraints: |
Property | Added | Data | N/A | Name: in_deletion Type: Boolean Description: The deletion status of this site, true if in deletion Constraints: |
Property | Added | Data | N/A | Name: link Type: String Description: A link directly to the site Constraints: |
Property | Added | Data | N/A | Name: storefront_status Type: Enum {online, maintenance, to_be_deleted, protected} Description: Constraints: |
Site
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: default_currency Type: String Description: The currency mnemonic of the site. Constraints: |
Property | Removed | Shop | Name: currency Type: String Description: The currency mnemonic of the site. Constraints: |
N/A |
Property | Changed | Shop | Name: allowed_locales Type: [String] |
Name: allowed_locales Type: [Locale] |
SlotConfiguration
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: assignment_information Type: SlotConfigurationAssignmentInformation Description: Information about the assignments and assignment schedules of this slot configuration Constraints: |
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Changed | Data | Name: callout_msg Type: [String] |
Name: callout_msg Type: [MarkupText] |
SlotContent
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Changed | Data | Name: body Type: [String] |
Name: body Type: [MarkupText] |
Store
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: creation_date Type: Date Description: Returns the value of attribute 'creationDate'. Constraints: |
Property | Added | Data | N/A | Name: last_modified Type: Date Description: Returns the value of attribute 'lastModified'. Constraints: |
Property | Added | Data | N/A | Name: pos_enabled Type: Boolean Description: Whether this store uses our Store product for Point-of-Sale Constraints: |
Property | Added | Data | N/A | Name: store_locator_enabled Type: Boolean Description: Whether this store should appear in store locator searches Constraints: |
Property | Changed | Data | Name: image Type: String Constraints: maxLength=256 |
Name: image Type: MediaFile Constraints: |
Property | Changed | Data | Name: store_events Type: [String] |
Name: store_events Type: [MarkupText] |
Property | Changed | Data | Name: store_hours Type: [String] |
Name: store_hours Type: [MarkupText] |
Store
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: pos_enabled Type: Boolean Description: Whether this store uses Store Point-of-Sale. Constraints: |
Property | Added | Shop | N/A | Name: store_locator_enabled Type: Boolean Description: Whether this store should show up in store locator results. Constraints: |
Suggestion
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: suggested_phrases Type: [SuggestedPhrase] Description: A list of suggested phrases. This list can be empty. Constraints: |
Property | Added | Shop | N/A | Name: suggested_terms Type: [SuggestedTerms] Description: A list of suggested terms. This list can be empty. Constraints: |
SuggestionResult
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Shop | N/A | Name: brand_suggestions Type: Suggestion Description: Returns the suggested brands. Constraints: |
Property | Added | Shop | N/A | Name: category_suggestions Type: Suggestion Description: Returns the suggested categories. Constraints: |
Property | Added | Shop | N/A | Name: content_suggestions Type: Suggestion Description: Returns the suggested content. Constraints: |
Property | Added | Shop | N/A | Name: custom_suggestions Type: Suggestion Description: Returns the suggested custom suggestions. Constraints: |
Property | Added | Shop | N/A | Name: product_suggestions Type: Suggestion Description: Returns the suggested products. Constraints: |
Property | Removed | Shop | Name: suggested_phrases Type: [String] Description: The suggested phrases. Constraints: |
N/A |
Property | Removed | Shop | Name: suggestions Type: [Suggestion] Description: The sorted list of search hits. This list can be empty. Constraints: |
N/A |
Variant
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: variation_attributes Type: [VariationAttribute] Description: variation attributes Constraints: |
Property | Changed | Data | Name: image Type: Image |
Name: image Type: MediaFile |
VariationAttribute
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: attribute_definition_id Type: String Description: The id of the requested attribute definition. Constraints: mandatory=true, nullable=false |
Property | Added | Data | N/A | Name: attribute_definition_name Type: [String] Description: The localized display name of the variation attribute definition. Constraints: |
Property | Added | Data | N/A | Name: default_value Type: String Description: default variation attribute value Constraints: |
Property | Added | Data | N/A | Name: link Type: String Description: URL that is used to get this instance Constraints: |
Property | Added | Data | N/A | Name: shared Type: boolean Description: Returns the value of attribute 'shared' if attribute is local or shared Constraints: |
Property | Added | Data | N/A | Name: slicing Type: boolean Description: Returns the value of attribute 'slicing'. Constraints: |
Property | Added | Data | N/A | Name: variation_attribute_type Type: Enum {string, int, unknown} Description: variation attribute type Constraints: |
VariationAttributeValue
Element | Change | API | 16.5 | 19.1 |
---|---|---|---|---|
Property | Added | Data | N/A | Name: link Type: String Description: Constraints: |
Property | Added | Data | N/A | Name: position Type: Double Description: The position of the value among all values of a variation attribute. Constraints: |
Property | Changed | Data | Name: image Type: Image |
Name: image Type: MediaFile |
Property | Changed | Data | Name: image_swatch Type: Image |
Name: image_swatch Type: MediaFile |