The following sections describe all changes made to OCAPI since version 15.9.
Document Name | Change | API | Details |
---|---|---|---|
AbTest | Added | Data API | N/A |
AbTestGroup | Added | Data API | N/A |
AbTestSearchResult | Added | Data API | N/A |
AbTestSegment | Added | Data API | N/A |
AbTestSegmentStats | Added | Data API | N/A |
AbTestTrigger | Added | Data API | N/A |
AbTests | Added | Data API | N/A |
AccountTransaction | Added | Data API | N/A |
AddressLink | Removed | Shop API | N/A |
AlertDescriptor | Added | Data API | N/A |
AlertDescriptorSettings | Added | Data API | N/A |
AlertDescriptors | Added | Data API | N/A |
AlertDescriptorsRevalidationRequest | Added | Data API | N/A |
AlertItem | Added | Data API | N/A |
AlertItems | Added | Data API | N/A |
AlertSettings | Added | Data API | N/A |
ApplicationPermissions | Added | Data API | N/A |
ApproachingDiscount | Added | Shop API | N/A |
ApproachingDiscountResult | Added | Shop API | N/A |
AuthRequest | Changed | Shop API | More |
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 | Added | Data API | N/A |
CampaignPromotionExperience | Added | Data API | N/A |
CampaignSearchResult | 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 | Added | Data API | N/A |
CatalogCategoryId | Added | Data API | N/A |
CatalogSearchResult | Added | Data API | N/A |
Catalogs | Added | Data API | N/A |
Categories | Added | Data API | N/A |
Category | Added | Data API | N/A |
Category | Changed | Shop API | More |
CategoryLink | Added | Data API | N/A |
CategoryLinks | Added | Data API | N/A |
CategoryProductAssignment | Added | Data API | N/A |
CategoryProductAssignmentSearchRequest | Added | Data API | N/A |
CategoryProductAssignmentSearchResult | Added | Data API | N/A |
CategorySearchResult | Added | Data API | N/A |
CodeVersion | Added | Data API | N/A |
CodeVersionResult | Added | Data API | N/A |
ContentAsset | Changed | Data API | More |
ContentFolder | Changed | Data API | More |
ContentFolderAssignment | Changed | Data API | More |
Coupon | Changed | Data API | More |
CouponCode | Added | Data API | N/A |
CouponCodes | Added | Data API | N/A |
CouponMultiCodesRequest | Added | Data API | N/A |
CouponRedemption | Added | Data API | N/A |
CouponRedemptionSearchResult | Added | Data API | N/A |
Coupons | Added | Data API | N/A |
Credentials | Removed | Shop API | N/A |
CustomLogSettings | Added | Data API | N/A |
CustomObject | Changed | Data API | More |
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 | Added | Data API | N/A |
CustomerGroupMember | Added | Data API | N/A |
CustomerGroupMemberResult | Added | Data API | N/A |
CustomerGroupMemberSearchResult | Added | Data API | N/A |
CustomerGroupMembers | Added | Data API | N/A |
CustomerGroupResult | Added | Data API | N/A |
CustomerGroupSearchResult | Added | Data API | N/A |
CustomerGroups | 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 |
CustomerRegistration | 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 |
CustomersExtProfile | Added | Shop 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 |
Fault | Changed | Data API | More |
Fault | Changed | Shop API | More |
FunctionalPermission | Added | Data API | N/A |
FunctionalPermissions | Added | Data API | N/A |
GiftCertificate | Added | Data API | N/A |
GiftCertificateSearchResult | Added | Data API | N/A |
GiftCertificates | Added | Data API | N/A |
Image | Changed | Shop API | More |
ImageGroup | Added | Data API | N/A |
ImageGroup | Changed | Shop API | More |
InventoryList | Added | Data API | N/A |
InventoryListSearchResult | Added | Data API | N/A |
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 |
LogCategory | Added | Data API | N/A |
MarkupText | Added | Data API | N/A |
Master | Added | Data API | N/A |
Master | Changed | Shop API | More |
MediaFile | Added | Data API | N/A |
MenuAction | Added | Data API | N/A |
MenuItem | Added | Data API | N/A |
ModulePermissions | Added | Data API | N/A |
Money | Added | Data API | N/A |
Note | Changed | Shop API | More |
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 |
OcapiConfigsApiRequest | Added | Data API | N/A |
OcapiConfigsApiResponse | Added | Data API | N/A |
OptionItem | Changed | Shop API | More |
Order | Changed | Shop API | More |
OrderConfirmationStatusUpdateRequest | Added | Data API | N/A |
OrderExportStatusUpdateRequest | Added | Data API | N/A |
OrderExternalStatusUpdateRequest | Added | Data API | N/A |
OrderPaymentCardRequest | Changed | Shop API | More |
OrderPaymentInstrument | Changed | Shop API | More |
OrderPaymentStatusUpdateRequest | Added | Data API | N/A |
OrderSearchHit | Changed | Shop API | More |
OrderSearchRequest | Changed | Shop API | More |
OrderSearchResult | Changed | Shop API | More |
OrderShippingStatusUpdateRequest | Added | Data API | N/A |
OrderStatusUpdateRequest | Added | Data API | N/A |
OrderUpdateRequest | Added | Data API | N/A |
OrganizationPreferences | Added | Data API | N/A |
PasswordChangeRequest | Added | Data API | N/A |
PasswordChangeRequest | Added | Shop API | N/A |
PasswordReset | Added | Shop API | N/A |
PathRecord | Added | Data API | N/A |
PathRecord | Added | Shop API | N/A |
PaymentInstrumentUpdateRequest | Added | Data API | N/A |
PaymentMethod | Changed | Shop API | More |
PaymentMethodResult | Changed | Shop API | More |
PaymentTransactionUpdateRequest | Added | Data API | N/A |
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 |
PriceAdjustmentRequest | Changed | Shop API | More |
Product | Added | Data API | N/A |
Product | Changed | Shop API | More |
ProductInventoryRecord | Added | Data API | N/A |
ProductInventoryRecordAllocation | Added | Data API | N/A |
ProductInventoryRecords | Added | Data API | N/A |
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 |
ProductListItemReference | Added | 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 | Added | Data API | N/A |
ProductSearchResult | Changed | Shop API | More |
ProductSimpleLink | Added | Shop API | N/A |
ProductType | Added | Data API | N/A |
Profile | Removed | 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 |
Registration | Removed | Shop API | N/A |
ResourceInfo | Added | Data API | N/A |
ResourceObject | 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 |
RoleSearchRequest | 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 |
Rule | Added | Data API | N/A |
SearchIndexUpdateConfiguration | Added | Data API | N/A |
ShippingAddressUpdateRequest | 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 |
SiteResourceInfo | Added | Data API | N/A |
SiteSearchResult | Added | Data API | N/A |
Sites | Added | Data API | N/A |
Slot | 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 |
SortingRule | Added | Data API | N/A |
SortingRuleSearchResult | Added | Data API | N/A |
SortingRuleStep | 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 |
StatusMetadata | Added | Data API | N/A |
Store | Added | Data API | N/A |
Store | Changed | Shop API | More |
StoreSearchResult | Added | Data API | N/A |
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 |
TrustedSystemAuthRequest | Added | Shop API | N/A |
User | Added | Data API | N/A |
UserSearchResult | Added | Data API | N/A |
Users | Added | Data API | N/A |
Variant | Added | Data API | N/A |
Variant | Changed | Shop API | More |
VariantSearchResult | Added | Data API | N/A |
Variants | Added | Data API | N/A |
VariationAttribute | Added | Data API | N/A |
VariationAttributeValue | Added | Data API | N/A |
VariationAttributeValues | Added | Data API | N/A |
VariationAttributes | Added | Data API | N/A |
VariationGroup | Added | Data API | N/A |
VariationGroup | Changed | Shop API | More |
VariationGroups | Added | Data API | N/A |
VersionRangeObject | Added | Data API | N/A |
WebdavPermission | Added | Data API | N/A |
WebdavPermissions | Added | Data API | N/A |
The following requests have been modified since 15.9.
POST /baskets
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Creates a new basket. The created basket is initialized with default values. Data provided in the body document
will be populated into the created basket. It can be updated with further Shop API calls.
Considered values from the request body are:
basket_id property, which
should be integrated into the path of an update request, for example a POST to
/baskets/{basket_id}/items .
The resource supports JWT or
OAuth tokens for authentication:
/baskets/{basket_id}/submit or it is deleted using a DELETE to
resource /baskets/{basket_id} . The number of open baskets allowed depends on the
authentication method used:
|
Creates a new basket. The created basket is initialized with default values. Data provided in the body document
will be populated into the created basket. It can be updated with further Shop API calls.
Considered values from the request body are:
basket_id property, which
should be integrated into the path of an update request, for example a POST to
/baskets/{basket_id}/items .
The resource supports JWT or
OAuth tokens for authentication:
/orders or it is deleted using a DELETE to resource
/baskets/{basket_id} . The number of open baskets allowed depends on the authentication
method used:
|
Fault | Added | Shop | N/A | ShipmentNotFoundException(404): Thrown if the shipment with the given shipment id is unknown. shipmentId (String) |
Fault | Removed | Shop | NotFoundException(404): Thrown if the shipment with the given shipment id is unknown. |
N/A |
DELETE /baskets/{basket_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: E-Tag to match to basket. Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
GET /baskets/{basket_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
PATCH /baskets/{basket_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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. |
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | SourceCodeNotFoundException(404): Indicates that the provided code was not found. sourceCode (String) |
Fault | Added | Shop | N/A | UnsupportedCurrencyException(400): Indicates that the basket cannot be updated because the requested currency is not supported by the site. currency (String) |
Fault | Added | Shop | N/A | SourceCodeInactiveException(400): Indicates that the provided code is not currently active. sourceCode (String) |
Fault | Added | Shop | N/A | ShippingItemNotFoundException(404): Indicates that the shipping item with the given item id is unknown for the basket shippingItemId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or the shipping item with the given item id is unknown for the basket. |
N/A |
PUT /baskets/{basket_id}/billing_address
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | AddressNotFoundException(404): Indicates that the address specified by customer_address_id is unknown. addressName (String) |
Fault | Added | Shop | N/A | EmptyBillingAddressException(400): Indicates that the billing address was null and no customer_address_id was provided. |
Fault | Removed | Shop | InvalidBillingAddressException(400): Indicates that the billing address was null and no customer_address_id was provided. |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or that the address specified by customer_address_id is unknown. |
N/A |
POST /baskets/{basket_id}/coupons
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: The ETag header value contained in the server response. Constraints: |
N/A |
Fault | Added | Shop | N/A | InvalidCouponCodeException(400): Thrown if the coupon code specified is invalid. couponCode (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | InvalidCouponItemException(400): Thrown if the coupon number specified is invalid. couponCode (String) |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
DELETE /baskets/{basket_id}/coupons/{coupon_item_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | CouponItemNotFoundException(404): Indicates that the couponItemId URL parameter does not match any coupon item id in the basket. couponItemId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or that the couponItemId URL parameter does not match any coupon item id in the basket. |
N/A |
PUT /baskets/{basket_id}/customer
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | CustomerNotFoundException(404): Indicates that the customer with the given customer number is unknown. customerId (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the customer with the given customer number is unknown or the basket with the given basket id is unknown. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
Fault | Changed | Shop | CustomerBasketsQuotaExceededException(400): Indicates that the customer cannot be set to the basket because the max number of baskets per customer quota will be exceeded. basketIds (String) |
CustomerBasketsQuotaExceededException(400): Indicates that the customer cannot be set to the basket because the max number of baskets per customer would be exceeded. basketIds (String) |
POST /baskets/{basket_id}/gift_certificate_items
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | InvalidGiftCertificateItemAmountException(400): Indicates that the gift certificate item amount is negative. giftCertificateItemAmount (Decimal) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | ShipmentNotFoundException(404): Indicates that the shipment with the given shipment id is unknown. shipmentId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or that the shipment with the given shipment id is unknown. |
N/A |
POST /baskets/{basket_id}/items
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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:
|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: The ETag header value contained in the server response. Constraints: |
N/A |
Fault | Added | Shop | N/A | InvalidProductOptionItemException(400): Indicates that an option with the specified option id is unknown. productId (String) optionId (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | ShipmentNotFoundException(404): Indicates that the basket does not contain a shipment with the given shipment id. shipmentId (String) |
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 | InvalidProductItemQuantityException(400): Indicates a null quantity value |
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) |
Fault | Added | Shop | N/A | InvalidProductOptionValueItemException(400): Indicates that an option with the specified option value id is unknown. productId (String) optionValueId (String) optionId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or the basket does not contain shipment with the given shipment id. |
N/A |
Fault | Removed | Shop | InvalidOptionItemException(400): Indicates that an option with the given option id or option value id is not supported. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
Fault | Changed | Shop | BasketQuotaExceededException(400): Indicates that the maximum allowed number, of products added to the basket, has been exceeded. |
BasketQuotaExceededException(400): Indicates that the maximum allowed number, of products added to the basket, has been exceeded. |
Fault | Changed | Shop | ProductItemNotAvailableException(400): Indicates that the requested product quantity is not available. productId (String) quantity (Decimal) |
ProductItemNotAvailableException(400): Indicates that the requested product quantity is not available. productId (String) quantity (Decimal) |
Fault | Changed | Shop | InvalidProductItemException(400): Indicates that the product with the given product id is
unknown, offline or not assigned to site catalog or the
given product item quantity is productId (String) |
InvalidProductItemException(400): Indicates that the product with the given product id is unknown, offline or
not assigned to site catalog or the given product item quantity is productId (String) |
Fault | Changed | Shop | InvalidProductTypeException(400): Indicates that the product cannot be added to the basket because of its type. productId (String) type (String) |
InvalidProductTypeException(400): Indicates that the product cannot be added to the basket because of its type. productId (String) type (String) |
Fault | Changed | Shop | InvalidProductIdException(400): Indicates that the given product id is |
InvalidProductIdException(400): Indicates that the given product id is |
DELETE /baskets/{basket_id}/items/{item_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | ProductItemNotFoundException(404): Indicates that the product item with the given product item id is unknown. itemId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
PATCH /baskets/{basket_id}/items/{item_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | InvalidProductOptionItemException(400): Indicates that an option with the specified option id is unknown. optionId (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown basketId (String) |
Fault | Added | Shop | N/A | ShipmentNotFoundException(404): Indicates that a shipment with it's given id is unknown. shipmentId (String) |
Fault | Added | Shop | N/A | InvalidProductItemQuantityException(400): Indicates a null quantity value |
Fault | Added | Shop | N/A | InvalidProductOptionValueItemException(400): Indicates that an option with the specified option value id is unknown. optionValueId (String) optionId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id or a shipment with the given id is unknown. |
N/A |
Fault | Removed | Shop | InvalidOptionItemException(400): Indicates that an option with the specified option id or option value id is not supported. |
N/A |
Fault | Changed | Shop | InvalidProductItemIdException(400): Indicates that the product item with given id was not found for the basket. productItemId (String) |
InvalidProductItemIdException(400): Indicates that no product item with given item id was found for the basket. productItemId (String) |
Fault | Changed | Shop | InvalidProductItemException(400): Indicates that the given product id in the request body is invalid. productId (String) |
InvalidProductItemException(400): Indicates that the product with the given product id in the request body is invalid. productId (String) |
GET /baskets/{basket_id}/notes
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
POST /baskets/{basket_id}/notes
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
POST /baskets/{basket_id}/payment_instruments
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Adds a payment instrument to a basket. | Adds a payment instrument to a basket.
Payment instruments are usually authorized after order creation, for example in a custom hook. The default
payment authorization process executes an authorization when a payment instrument is added to an order or
updated. See |
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given customer payment instrument id is unknown. paymentInstrumentId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or the payment instrument with the given customer payment instrument id is unknown. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
DELETE /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown. paymentInstrumentId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
PATCH /baskets/{basket_id}/payment_instruments/{payment_instrument_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Updates a payment instrument of a basket. | Updates a payment instrument of a basket.
Payment instruments are usually authorized after order creation, for example in a custom hook. The default
payment authorization process executes an authorization when a payment instrument is added to an order or
updated. See |
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown. paymentInstrumentId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or the payment instrument with the given payment instrument number is unknown. |
N/A |
Fault | Changed | Shop | PaymentInstrumentPermanentlyMaskedException(400): Indicates that the basket payment instrument with the given id already is permanently masked. paymentInstrumentId (String) |
PaymentInstrumentPermanentlyMaskedException(400): Indicates that the basket payment instrument with the given
id already is permanently masked. Please see
paymentInstrumentId (String) |
GET /baskets/{basket_id}/payment_methods
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Gets applicable payment methods for an existing basket. | Gets applicable payment methods for an existing basket considering the open payment amount only. |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
POST /baskets/{basket_id}/price_adjustments
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | PriceAdjustmentLimitExceededException(400): Indicates that the price adjustment limit is exceeded. priceAdjustmentLimit (Decimal) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
DELETE /baskets/{basket_id}/price_adjustments/{price_adjustment_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
POST /baskets/{basket_id}/shipments
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Creates a new shipment for a basket.
The created shipment is initialized
with values provided in the body document and can be updated with further data API calls. Considered from the
body are the following properties if specified:
|
Creates a new shipment for a basket.
The created shipment is initialized with values provided in the body
document and can be updated with further data API calls. Considered from
the body are the following properties if specified:
|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: The ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | InvalidShippingMethodIdException(400): Indicates that a shipping method with an id was specified which is not a valid shipping method id. shippingMethodId (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | InvalidShippingMethodException(400): Indicates that a shipping method with an id was specified which is not a valid shipping method id. |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customer assigned to the basket does not match the verified customer represented by the JWT, not relevant when using OAuth. |
Fault | Changed | Shop | DuplicateShipmentIdException(400): Indicates that a shipment with the provided id already exists for the basket. shipmentId (String) |
DuplicateShipmentIdException(400): Indicates that a shipment with the provided id already exists for the basket. shipmentId (String) |
Fault | Changed | Shop | DuplicateShipmentNoException(400): Indicates that a shipment with the provided shipment number already exists for the basket. shipmentNo (String) |
DuplicateShipmentNoException(400): Indicates that a shipment with the provided shipment number already exists for the basket. shipmentNo (String) |
PATCH /baskets/{basket_id}/shipments/{shipment_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: Constraints: |
N/A |
Fault | Added | Shop | N/A | InvalidShippingMethodIdException(400): Indicates an invalid shipping method. shippingMethodId (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | MissingShippingMethodIdException(400): Indicates a missing shipping method. shipmentId (String) |
Fault | Removed | Shop | InvalidShippingMethodException(400): Indicates that a shipping method with an id was specified which is not a valid shipping method id. |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_address
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: The ETag header value contained in the server response. Constraints: |
N/A |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | AddressNotFoundException(404): Indicates that the address specified by customer_address_id is unknown. addressName (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or that the address specified by customer_address_id is unknown. |
N/A |
PUT /baskets/{basket_id}/shipments/{shipment_id}/shipping_method
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | MissingShippingMethodIdException(400): Indicates that the id of the shipping method is missing. shipmentId (String) |
Fault | Added | Shop | N/A | InvalidShippingMethodIdException(400): Indicates that a shipping method with an id was specified which is not a valid shipping method id. shippingMethodId (String) |
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Removed | Shop | InvalidShippingMethodException(400): Indicates that a shipping method with the given shipping method id is unknown or non-applicable for that shipment. |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown. |
N/A |
GET /baskets/{basket_id}/shipments/{shipment_id}/shipping_methods
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | BasketNotFoundException(404): Indicates that the basket with the given basket id is unknown. basketId (String) |
Fault | Added | Shop | N/A | ShipmentNotFoundException(404): Indicates that the shipment with the given shipment id is unknown. shipmentId (String) |
Fault | Removed | Shop | InvalidShipmentIdException(400): Indicates that the given shipment id is invalid. shipmentId (String) |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the basket with the given basket id is unknown or the shipment with the given shipment id is unknown. |
N/A |
GET /categories/({id},...,{id})
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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. |
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 | 15.9 | 20.10 |
---|---|---|---|---|
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. |
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. |
Fault | Added | Shop | N/A | CategoryNotFoundException(404): Thrown if the server could not find an online category with the specified id. categoryId (String) siteId (String) |
Fault | Removed | Shop | NotFoundException(404): Thrown if the server could not find an online category with the specified id. |
N/A |
GET /content/({id},...,{id})
GET /content/{id}
GET /content_search
GET /sites/{site_id}/coupons/{coupon_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Data | Action to get coupon information. | Action to get coupon information.
The following fields are returned in the Coupon document when specifying the stats expand:
If the role to which the user belongs does not have View_Coupon_Codes permission, then the coupon codes returned will be masked.
|
Query Parameter | Added | Data | N/A | Name: expand Type: [String] Description: The expand parameter. A comma separated list with the allowed values (stats). Constraints: |
Fault | Removed | Data | SiteAccessForbiddenException(403): Thrown if the resource requires global instead of site-specific context. siteId (String) |
N/A |
PATCH /sites/{site_id}/coupons/{coupon_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Data | Updates the coupon with the specified information. The request must include the If-Match header, which holds the last known base-point information. The value of this header is an "ETag" representing the coupon state. If the request does not contain an If-Match header with the current server customer "ETag", a 409 (IfMatchRequiredException) fault is returned. If the If-Match header does not match the current server coupon "ETag", a 412 (InvalidIfMatchException) fault is returned. | Updates the coupon with the specified information. |
Header Parameter | Removed | Data | Name: If-Match Type: String Description: Must match the last eTag. Constraints: |
N/A |
Fault | Added | Data | N/A | CouponUpdateForbiddenException(403): Thrown when trying to update a broken coupon, that should be deleted and re-created. couponId (String) |
Fault | Added | Data | N/A | CouponLegacyUpdateForbiddenException(403): Thrown when trying to update a legacy coupon. couponId (String) |
PATCH /custom_objects/{object_type}/{key}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Data | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
GET /custom_objects/{object_type}/{key}
PATCH /customer_lists/{list_id}/customers/{customer_no}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Data | Updates the customer with the specified information. The customer number is allowed to be updated but will result in a CustomerNumberAlreadyInUseException if there is already another customer with the same customer number existing. | Updates the customer with the specified information. The customer number is allowed to be updated but will result in a CustomerNumberAlreadyInUseException if there is already another customer with the same customer number existing. |
Header Parameter | Removed | Data | Name: If-Match Type: String Description: The ETag header value contained in the server response Constraints: |
N/A |
PATCH /customer_lists/{list_id}/customers/{customer_no}/addresses/{address_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Data | Name: If-Match Type: String Description: The ETag header value contained in the server response Constraints: |
N/A |
POST /customers/auth
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Obtains a new JWT (JSON Web Token) for a guest or registered
customer. Tokens are returned as a HTTP Authorization:Bearer response
header entry. These kinds of request are supported, as specified by the
type :
About JWT The token contains 3 sections:
Authorization: Bearer --token--
The client has to include the token in the request header as
Authorization: Bearer --token--
in any follow up request. The server declines any follow up requests
without a token or which cannot be verified based on the token signature
or expiration time. A token nearing its expiration time should be
exchanged for a new one (type "refresh").
See "API Usage > JWT" for more details on using JWT as an authentication
mechanism. |
Obtains a new JWT (JSON Web Token) for a guest or registered
customer. Tokens are returned as a HTTP Authorization:Bearer response
header entry. These kinds of request are supported, as specified by the
type :
About JWT The token contains 3 sections:
Authorization: Bearer --token--
The client has to include the token in the request header as
Authorization: Bearer --token--
in any follow up request. The server declines any follow up requests
without a token or which cannot be verified based on the token signature
or expiration time. A token nearing its expiration time should be
exchanged for a new one (type "refresh").
See "API Usage > JWT" for more details on using JWT as an authentication
mechanism. |
Fault | Changed | Shop | AuthenticationFailedException(401): Indicates that the username is unknown or the password does not match. credentialType (String) |
AuthenticationFailedException(401): Indicates in case of type credentials the username is unknown or the password does not match. In case of type session the session is not active anymore or the dwsecuretoken value is invalid. In both cases the customer is disabled or locked. credentialType (String) |
GET /customers/{customer_id}/addresses
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Returns a sorted pageable list of all customer addresses in the address book. The default page size is 10 customer addresses. The addresses are sorted so that the preferred address is always sorted first. The remaining addresses are sorted alphabetically by ID. | Returns a sorted pageable list of all customer addresses in the address book. The default page size is 10
customer addresses. The addresses are sorted so that the preferred address is always sorted first. The remaining
addresses are sorted alphabetically by ID.
When the customer cannot be found CustomerNotFoundException
is thrown in a case of an agent but an empty result list is returned in a case of JWT. |
Query Parameter | Changed | Shop | Name: start Description: The result set index to return the first instance for. Default value is 0. |
Name: start Description: The result set index to return the first instance for. Default value is 0. |
Query Parameter | Changed | Shop | Name: count Description: The maximum number of instances per request. Default value is 25. |
Name: count Description: The maximum number of instances per request. Default value is 25. |
Fault | Changed | Shop | InvalidCustomerException(400): If customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): If customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth. |
GET /customers/{customer_id}/orders
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Gets customer payment instruments for an customer.
Can be limited to a specific payment
method by providing query parameter payment_method_id . |
Gets customer payment instruments for an customer.
Can be limited to a specific payment
method by providing query parameter payment_method_id .
When the customer cannot be found CustomerNotFoundException
is thrown in a case of an agent but an empty result list is returned in a case of JWT. |
Fault | Added | Shop | N/A | CustomerNotFoundException(404): Indicates that the customer with the given customer id is unknown for the site. customerId (String) |
POST /customers/{customer_id}/payment_instruments
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | CustomerNotFoundException(404): Indicates that the customer with the given customer id is unknown for the site. customerId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the customer with the given customer id is unknown. |
N/A |
DELETE /customers/{customer_id}/payment_instruments/{payment_instrument_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | CustomerNotFoundException(404): Indicates that the customer with the given customer id is unknown for the site. customerId (String) |
Fault | Changed | Shop | InvalidCustomerException(400): Indicates that the customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth. |
InvalidCustomerException(400): Indicates that the customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth. |
GET /customers/{customer_id}/payment_instruments/{payment_instrument_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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 | Added | Shop | N/A | CustomerNotFoundException(404): Indicates that the customer with the given customer id is unknown for the site. customerId (String) |
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given id is unknown for the customer with the given customer id. paymentInstrumentId (String) |
Fault | Removed | Shop | InvalidCustomerException(400): Indicates that the customerId URL parameter does not match the verified customer represented by the JWT, not relevant when using OAuth. |
N/A |
Fault | Removed | Shop | NotFoundException(404): Indicates that the payment instrument with the given id is unknown for the customer with the given customer id. |
N/A |
GET /folders/({id},...,{id})
GET /folders/{id}
POST /gift_certificate
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | GiftCertificateNotFoundException(404): Thrown if the given gift certificate code is not valid. |
Fault | Removed | Shop | NotFoundException(404): Thrown if the given gift certificate code is not valid. |
N/A |
PATCH /libraries/{library_id}/content/{content_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Data | Updates a content asset. In the request, the If-Match header is required. The value of the header is an 'ETag' representing the last known base-point information for the content asset. If the header is missing, the server returns a 409 (IfMatchRequiredException) fault. If the header value does not match the server's 'ETag', the server returns a 412 (InvalidIfMatchException) fault. The delta information for the library folder containing the content asset is updated atomically: the information is written completely or not at all. If the content asset is locked, the server returns a 409 (ResourceLockedException) fault. | Updates a content asset. In the request, the If-Match header is required. The value of the header is an 'ETag' representing the last known base-point information for the content asset. If the header is missing, the server returns a 409 (IfMatchRequiredException) fault. If the header value does not match the server's 'ETag', the server returns a 412 (InvalidIfMatchException) fault. The delta information for the library folder containing the content asset is updated atomically: the information is written completely or not at all. If the content asset is locked, the server returns a 409 (ResourceLockedException) fault. |
Header Parameter | Removed | Data | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
PUT /libraries/{library_id}/folder_assignments/{content_id}/{folder_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Path Parameter | Changed | Data | Name: library_id Description: ID of the shared library or the site-id in case of a private library. |
Name: library_id Description: the ID of the shared library or the site-id in case of a private library |
Path Parameter | Changed | Data | Name: content_id Description: the ID of the content asset to retrieve. |
Name: content_id Description: the content id |
Path Parameter | Changed | Data | Name: folder_id Description: ID of a target folder. |
Name: folder_id Description: the folder id |
PATCH /libraries/{library_id}/folders/{folder_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Data | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
POST /order_search
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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 |
GET /orders/{order_no}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | OrderNotFoundException(404): Indicates that the order with the given order number is unknown. orderNumber (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the order with the given order number is unknown. |
N/A |
GET /orders/{order_no}/notes
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | OrderNotFoundException(404): Thrown if the order with the given order number is unknown. orderNumber (String) |
Fault | Removed | Shop | NotFoundException(404): Thrown if the order with the given order number is unknown. |
N/A |
POST /orders/{order_no}/notes
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Fault | Added | Shop | N/A | OrderNotFoundException(404): Thrown if the order with the given order number is unknown. orderNumber (String) |
Fault | Removed | Shop | NotFoundException(404): Thrown if the order with the given order number is unknown. |
N/A |
POST /orders/{order_no}/payment_instruments
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Adds a payment instrument to an order. It is possible either to supply the full payment information or only a customer payment instrument id and amount. In case the customer payment instrument id was set all the other properties (except amount) are ignored and the payment data is resolved from the stored customer payment information. An attempt is made to authorize the order by passing it to the authorize or authorizeCreditCard hook. Details:
|
Adds a payment instrument to an order. It is possible either to supply the full payment information or only a customer payment instrument id and amount. In case the customer payment instrument id was set all the other properties (except amount) are ignored and the payment data is resolved from the stored customer payment information. An attempt is made to authorize the order by passing it to the authorize or authorizeCreditCard hook. Details:
|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Query Parameter | Added | Shop | N/A | Name: skip_authorization Type: Boolean Description: Constraints: |
Fault | Added | Shop | N/A | OrderNotFoundException(404): Indicates that the order with the given order number is unknown. orderNumber (String) |
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that a customer payment instrument could not be resolved based on the provided customer payment instrument id. paymentInstrumentId (String) |
Fault | Removed | Shop | NotFoundException(404): Indicates that the order with the given order number is unknown or payment instrument could not be resolved based on the provided customer payment instrument id. |
N/A |
DELETE /orders/{order_no}/payment_instruments/{payment_instrument_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Fault | Added | Shop | N/A | PaymentInstrumentNotFoundException(404): Indicates that the payment instrument with the given payment instrument number is unknown. paymentInstrumentId (String) |
PATCH /orders/{order_no}/payment_instruments/{payment_instrument_id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Updates a payment instrument of an order and passes the order and updated payment instrument to the correct payment authorizeCreditcard or authorize hook. Details:
|
Updates a payment instrument of an order and passes the order and updated payment instrument to the correct payment authorizeCreditcard or authorize hook. Details:
|
Header Parameter | Removed | Shop | Name: If-Match Type: String Description: the ETag header value contained in the server response Constraints: |
N/A |
Query Parameter | Added | Shop | N/A | Name: skip_authorization Type: Boolean Description: Constraints: |
GET /product_lists
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
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 | JWT: Authentication via Customer JWT. |
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 | 15.9 | 20.10 |
---|---|---|---|---|
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 | JWT: Authentication via Customer JWT. |
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 | 15.9 | 20.10 |
---|---|---|---|---|
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 | JWT: Authentication via Customer JWT. |
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 | 15.9 | 20.10 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
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
GET /product_search/images
GET /product_search/prices
GET /product_search/variations
GET /products/({id},...,{id})
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Description | Changed | Shop | Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 50. | Allows to access multiple products by a single request. This convenience resource should be used instead making separated requests. This saves bandwidth and CPU time on the server. The URI is the same like requesting a single Product by id, but multiple ids wrapped by parentheses and separated can be provided. If a parenthesis or the separator is part of the identifier itself it has to be URL encoded. Instead of a single Product document a result object of Product documents is returned. Note: Only products that are online and assigned to site catalog are returned. The maximum number of ids is 24. If none of the products requested are found, the cache-control header will be defaulted to 60 seconds. |
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
Path Parameter | Changed | Shop | Name: ids Constraints: maxItems=50, maxLength=100 |
Name: ids Constraints: maxItems=24, maxLength=100 |
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 | 15.9 | 20.10 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
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
GET /products/{id}/bundled_products
GET /products/{id}/images
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
Query Parameter | Added | Shop | N/A | Name: all_images Type: Boolean Description: If set to true, all images according to the requested product, view type and attribute value filter are returned. If set to false (or omitted), the best matching image for the requested product is returned. The attribute value filter is ignored in such case. Constraints: |
Query Parameter | Added | Shop | N/A | Name: variation_attribute Type: [String, String] Description: the variation values context Constraints: maxLength=256 |
Query Parameter | Removed | Shop | Name: variation_value Type: String Description: The variation value context. Constraints: maxLength=256 |
N/A |
Query Parameter | Changed | Shop | Name: view_type Type: String Description: The view type. |
Name: view_type Type: [String] Description: The view types. |
GET /products/{id}/links
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
Fault | Added | Shop | N/A | MalformedLinkTypeCodeParameterException(400): 400 indicates unknown product link type code linkType (String) |
Fault | Added | Shop | N/A | MalformedLinkDirectionParameterException(400): 400 indicates unknown link direction linkDirection (String) |
Fault | Added | Shop | N/A | ProductNotFoundException(404): 404 No product with given id found productId (String) siteId (String) |
Fault | Removed | Shop | NotFoundException(404): 404 product with id not found |
N/A |
GET /products/{id}/options
GET /products/{id}/prices
GET /products/{id}/promotions
GET /products/{id}/recommendations
GET /products/{id}/set_products
GET /products/{id}/variations
GET /promotions
GET /promotions/({id},...,{id})
GET /promotions/{id}
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
Fault | Added | Shop | N/A | PromotionNotFoundException(404): Thrown when there is no promotion found with the given ID for the requested site promotionId (String) siteId (String) |
Fault | Removed | Shop | NotFoundException(404): Thrown when there is no promotion existing with the given ID for the requested site |
N/A |
GET /search_suggestion
GET /site
Element | Change | API | 15.9 | 20.10 |
---|---|---|---|---|
Authentication | Added | Shop | N/A | JWT: Authentication via Customer JWT. |
Fault | Removed | Shop | NotFoundException(404): Thrown if the server could not find a site with the specified id. |
N/A |
PATCH /sites/{site_id}/custom_objects/{object_type}/{key}