Path Parameter sanitization
Path parameters like key and ID are now being URL encoded. We release this change as a new major version as this can potentially lead to issues when special characters are being used for keys or stores.
What's Changed
Due to some issue the latest releases were missing code changes. The complete list of changes with this release:
Api changes
Added Resource(s)
- added resource
/{projectKey}/discount-groups - added resource
/{projectKey}/payment-methods - added resource
/{projectKey}/recurring-orders - added resource
/{projectKey}/recurrence-policies - added resource
/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/shopping-lists - added resource
/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/shopping-lists/key={key} - added resource
/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/shopping-lists/{ID} - added resource
/{projectKey}/business-units/key={key}/associates/{associateId} - added resource
/{projectKey}/business-units/{businessUnitId}/associates/{associateId} - added resource
/{projectKey}/carts/customer-id={customerId}/merge - added resource
/{projectKey}/discount-groups/key={key} - added resource
/{projectKey}/discount-groups/{ID} - added resource
/{projectKey}/payment-methods/key={key} - added resource
/{projectKey}/payment-methods/{ID} - added resource
/{projectKey}/recurring-orders/{ID} - added resource
/{projectKey}/recurring-orders/key={key} - added resource
/{projectKey}/recurrence-policies/key={key} - added resource
/{projectKey}/recurrence-policies/{ID} - added resource
/{projectKey}/in-store/key={storeKey}/business-units - added resource
/{projectKey}/in-store/key={storeKey}/business-units/key={key} - added resource
/{projectKey}/in-store/key={storeKey}/business-units/{ID} - added resource
/{projectKey}/in-store/key={storeKey}/business-units/key={key}/associates/{associateId} - added resource
/{projectKey}/in-store/key={storeKey}/business-units/{businessUnitId}/associates/{associateId} - added resource
/{projectKey}/in-store/key={storeKey}/carts/customer-id={customerId}/merge
Added QueryParameter(s)
- added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/products - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/products - added query parameter
priceCustomerGroupAssignmentsto methodpost /{projectKey}/products - added query parameter
priceRecurrencePolicyto methodpost /{projectKey}/products - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/product-projections - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/product-projections - added query parameter
filter[attributes]to methodget /{projectKey}/product-projections - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/products/key={key} - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/products/key={key} - added query parameter
priceCustomerGroupAssignmentsto methodpost /{projectKey}/products/key={key} - added query parameter
priceRecurrencePolicyto methodpost /{projectKey}/products/key={key} - added query parameter
priceCustomerGroupAssignmentsto methoddelete /{projectKey}/products/key={key} - added query parameter
priceRecurrencePolicyto methoddelete /{projectKey}/products/key={key} - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/products/{ID} - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/products/{ID} - added query parameter
priceCustomerGroupAssignmentsto methodpost /{projectKey}/products/{ID} - added query parameter
priceRecurrencePolicyto methodpost /{projectKey}/products/{ID} - added query parameter
priceCustomerGroupAssignmentsto methoddelete /{projectKey}/products/{ID} - added query parameter
priceRecurrencePolicyto methoddelete /{projectKey}/products/{ID} - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/product-projections/search - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/product-projections/search - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/product-projections/key={key} - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/product-projections/key={key} - added query parameter
filter[attributes]to methodget /{projectKey}/product-projections/key={key} - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/product-projections/{ID} - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/product-projections/{ID} - added query parameter
filter[attributes]to methodget /{projectKey}/product-projections/{ID} - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/in-store/key={storeKey}/product-projections/key={key} - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/in-store/key={storeKey}/product-projections/key={key} - added query parameter
filter[attributes]to methodget /{projectKey}/in-store/key={storeKey}/product-projections/key={key} - added query parameter
priceCustomerGroupAssignmentsto methodget /{projectKey}/in-store/key={storeKey}/product-projections/{ID} - added query parameter
priceRecurrencePolicyto methodget /{projectKey}/in-store/key={storeKey}/product-projections/{ID} - added query parameter
filter[attributes]to methodget /{projectKey}/in-store/key={storeKey}/product-projections/{ID}
Removed QueryParameter(s)
⚠️ removed query parameterwithTotalfrom methodget /{projectKey}/product-projections/search
Added Enum(s)
- added enum
ViewMyShoppingListsto typePermission - added enum
ViewOthersShoppingListsto typePermission - added enum
UpdateMyShoppingListsto typePermission - added enum
UpdateOthersShoppingListsto typePermission - added enum
CreateMyShoppingListsto typePermission - added enum
CreateOthersShoppingListsto typePermission - added enum
DeleteMyShoppingListsto typePermission - added enum
DeleteOthersShoppingListsto typePermission - added enum
RecurringOrderto typeCartOrigin - added enum
ApplicationStoppedByGroupBestDealto typeDiscountCodeState - added enum
discount-groupto typeReferenceTypeId - added enum
payment-methodto typeReferenceTypeId - added enum
recurrence-policyto typeReferenceTypeId - added enum
recurring-orderto typeReferenceTypeId - added enum
payment-methodto typeExtensionResourceTypeId - added enum
RecurringOrderStateto typeStateTypeEnum - added enum
discount-groupto typeChangeSubscriptionResourceTypeId - added enum
recurrence-policyto typeChangeSubscriptionResourceTypeId - added enum
recurring-orderto typeChangeSubscriptionResourceTypeId - added enum
payment-methodto typeResourceTypeId - added enum
payment-method-infoto typeResourceTypeId - added enum
recurring-orderto typeResourceTypeId
Changed Property(s)
⚠️ changed propertydiscountof typeDiscountedTotalPricePortionfrom typeCartDiscountReferencetoReference⚠️ changed propertyactionsof typeMyBusinessUnitUpdatefrom typeBusinessUnitUpdateAction[]toMyBusinessUnitUpdateAction[]⚠️ changed propertypaymentMethodInfoof typeMyPaymentDraftfrom typePaymentMethodInfotoPaymentMethodInfoDraft⚠️ changed propertypaymentMethodInfoof typePaymentDraftfrom typePaymentMethodInfotoPaymentMethodInfoDraft⚠️ changed propertyfilterof typeSearchSortingfrom typeSearchQueryExpressiontoSearchQuery
Required Property(s)
- changed property
sortOrderof typeCartDiscountDraftto be optional - changed property
variantSelectionof typeProductSelectionProductAddedMessageto be optional - changed property
variantExclusionof typeProductSelectionProductExcludedMessageto be optional - changed property
oldVariantExclusionof typeProductSelectionVariantExclusionChangedMessageto be optional - changed property
newVariantExclusionof typeProductSelectionVariantExclusionChangedMessageto be optional - changed property
oldVariantSelectionof typeProductSelectionVariantSelectionChangedMessageto be optional - changed property
newVariantSelectionof typeProductSelectionVariantSelectionChangedMessageto be optional - changed property
variantSelectionof typeProductSelectionProductAddedMessagePayloadto be optional - changed property
variantExclusionof typeProductSelectionProductExcludedMessagePayloadto be optional - changed property
oldVariantExclusionof typeProductSelectionVariantExclusionChangedMessagePayloadto be optional - changed property
newVariantExclusionof typeProductSelectionVariantExclusionChangedMessagePayloadto be optional - changed property
oldVariantSelectionof typeProductSelectionVariantSelectionChangedMessagePayloadto be optional - changed property
newVariantSelectionof typeProductSelectionVariantSelectionChangedMessagePayloadto be optional - changed property
imagesof typeProductTailoringSetExternalImagesActionto be optional - changed property
facetsof typeProductProjectionPagedSearchResponseto be optional ⚠️ changed propertyshippingAddressIdsof typeBusinessUnitto be required⚠️ changed propertybillingAddressIdsof typeBusinessUnitto be required⚠️ changed propertyshippingAddressIdsof typeCompanyto be required⚠️ changed propertybillingAddressIdsof typeCompanyto be required⚠️ changed propertyshippingAddressIdsof typeDivisionto be required⚠️ changed propertybillingAddressIdsof typeDivisionto be required⚠️ changed propertytriggerPatternof typeCartDiscountPatternTargetto be required⚠️ changed propertyshippingAddressIdsof typeCustomerto be required⚠️ changed propertybillingAddressIdsof typeCustomerto be required⚠️ changed propertydeleteDaysAfterLastModificationof typeCartsConfigurationto be required⚠️ changed propertydeleteDaysAfterLastModificationof typeShoppingListsConfigurationto be required
Removed Property(s)
⚠️ removed propertypaymentfrom typeOrderPaymentAddedMessage⚠️ removed propertypaymentfrom typeOrderPaymentAddedMessagePayload⚠️ removed property/[0-9].[0-9]*[1-9]/from typeCategoryOrderHints⚠️ removed property//from typeProductVariantChannelAvailabilityMap⚠️ removed propertytierMinimumQuantityfrom typeStandalonePriceRemovePriceTierAction
Added Property(s)
- added property
inheritedStoresto typeBusinessUnit - added property
customerGroupAssignmentsto typeBusinessUnit - added property
customerGroupAssignmentsto typeBusinessUnitDraft - added property
inheritedStoresto typeCompany - added property
customerGroupAssignmentsto typeCompany - added property
customerGroupAssignmentsto typeCompanyDraft - added property
inheritedStoresto typeDivision - added property
customerGroupAssignmentsto typeDivision - added property
customerGroupAssignmentsto typeDivisionDraft - added property
makeInheritedAssociatesExplicitto typeBusinessUnitChangeAssociateModeAction - added property
discountGroupto typeCartDiscount - added property
recurringOrderScopeto typeCartDiscount - added property
discountGroupto typeCartDiscountDraft - added property
recurringOrderScopeto typeCartDiscountDraft - added property
applicationModeto typeCartDiscountValueRelative - added property
applicationModeto typeCartDiscountValueRelativeDraft - added property
priceRoundingModeto typeCart - added property
freezeStrategyto typeCart - added property
discountTypeCombinationto typeCart - added property
lockto typeCart - added property
purchaseOrderNumberto typeCart - added property
priceRoundingModeto typeCartDraft - added property
purchaseOrderNumberto typeCartDraft - added property
recurrenceInfoto typeCustomLineItem - added property
recurrenceInfoto typeCustomLineItemDraft - added property
recurrenceInfoto typeLineItem - added property
recurrenceInfoto typeLineItemDraft - added property
recurrenceInfoto typeCartAddCustomLineItemAction - added property
recurrenceInfoto typeCartAddLineItemAction - added property
strategyto typeCartFreezeCartAction - added property
recurrencePolicyto typePrice - added property
recurrencePolicyto typePriceDraft - added property
customerGroupAssignmentsto typeCustomer - added property
invalidateOlderTokensto typeCustomerCreateEmailToken - added property
invalidateOlderTokensto typeCustomerCreatePasswordResetToken - added property
customerGroupAssignmentsto typeCustomerDraft - added property
invalidateOlderTokensto typeCustomerToken - added property
minCartQuantityto typeInventoryEntry - added property
maxCartQuantityto typeInventoryEntry - added property
minCartQuantityto typeInventoryEntryDraft - added property
maxCartQuantityto typeInventoryEntryDraft - added property
recurrenceInfoto typeMyLineItemDraft - added property
interfaceIdto typeMyTransactionDraft - added property
recurrenceInfoto typeMyCartAddLineItemAction - added property
addressRolesto typeBusinessUnitAddressChangedMessage - added property
addressRolesto typeBusinessUnitAddressRemovedMessage - added property
addressRolesto typeCustomerAddressChangedMessage - added property
addressRolesto typeCustomerAddressRemovedMessage - added property
emailto typeCustomerDeletedMessage - added property
oldEmailto typeCustomerEmailChangedMessage - added property
valueto typeCustomerEmailTokenCreatedMessage - added property
invalidateOlderTokensto typeCustomerEmailTokenCreatedMessage - added property
valueto typeCustomerPasswordTokenCreatedMessage - added property
invalidateOlderTokensto typeCustomerPasswordTokenCreatedMessage - added property
skuto typeInventoryEntryQuantitySetMessage - added property
paymentRefto typeOrderPaymentAddedMessage - added property
attributesto typeProductTailoringCreatedMessage - added property
addressRolesto typeBusinessUnitAddressChangedMessagePayload - added property
addressRolesto typeBusinessUnitAddressRemovedMessagePayload - added property
addressRolesto typeCustomerAddressChangedMessagePayload - added property
addressRolesto typeCustomerAddressRemovedMessagePayload - added property
emailto typeCustomerDeletedMessagePayload - added property
oldEmailto typeCustomerEmailChangedMessagePayload - added property
valueto typeCustomerEmailTokenCreatedMessagePayload - added property
invalidateOlderTokensto typeCustomerEmailTokenCreatedMessagePayload - added property
valueto typeCustomerPasswordTokenCreatedMessagePayload - added property
invalidateOlderTokensto typeCustomerPasswordTokenCreatedMessagePayload - added property
skuto typeInventoryEntryQuantitySetMessagePayload - added property
paymentRefto typeOrderPaymentAddedMessagePayload - added property
attributesto typeProductTailoringCreatedMessagePayload - added property
priceRoundingModeto typeStagedOrder - added property
recurringOrderto typeStagedOrder - added property
discountTypeCombinationto typeStagedOrder - added property
recurrenceInfoto typeStagedOrderAddCustomLineItemAction - added property
recurrenceInfoto typeStagedOrderAddLineItemAction - added property
priceRoundingModeto typeOrder - added property
recurringOrderto typeOrder - added property
discountTypeCombinationto typeOrder - added property
priceRoundingModeto typeOrderImportDraft - added property
tokento typePaymentMethodInfo - added property
interfaceAccountto typePaymentMethodInfo - added property
customto typePaymentMethodInfo - added property
interfaceIdto typeTransaction - added property
interfaceIdto typeTransactionDraft - added property
priceCustomerGroupAssignmentsto typeProductSearchProjectionParams - added property
attributesto typeProductTailoringData - added property
attributesto typeProductTailoringDraft - added property
attributesto typeProductTailoringInStoreDraft - added property
levelto typeAttributeDefinition - added property
levelto typeAttributeDefinitionDraft - added property
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/to typeCategoryOrderHints - added property
attributesto typeProductData - added property
attributesto typeProductDraft - added property
attributesto typeProductProjection - added property
recurrencePricesto typeProductVariant - added property
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/to typeProductVariantChannelAvailabilityMap - added property
priceRoundingModeto typeCartsConfiguration - added property
taxRoundingModeto typeCartsConfiguration - added property
discountsto typeProject - added property
priceRoundingModeto typeQuoteRequest - added property
priceRoundingModeto typeQuote - added property
businessUnitto typeShoppingList - added property
businessUnitto typeShoppingListDraft - added property
publishedto typeShoppingListLineItem - added property
recurrencePolicyto typeStandalonePrice - added property
recurrencePolicyto typeStandalonePriceDraft - added property
minimumQuantityto typeStandalonePriceRemovePriceTierAction - added property
eventsto typeSubscription - added property
eventsto typeSubscriptionDraft
MarkDeprecated Property(s)
- marked property
CountOnCustomLineItemUnits::excludeCountas deprecated - marked property
CountOnLineItemUnits::excludeCountas deprecated - marked property
ProductSearchRequest::productProjectionParametersas deprecated - marked property
ProductSearchResult::productProjectionas deprecated
MarkDeprecated Type(s)
- marked type
ProductSearchProjectionParamsas deprecated
Removed Type(s)
⚠️ removed typeAssociateRoleNameChangedMessage⚠️ removed typeAssociateRoleNameChangedMessagePayload⚠️ removed typeProductSearchFacetScope
Added Type(s)
- added type
BusinessUnitAssociateResponse - added type
BusinessUnitAddCustomerGroupAssignmentAction - added type
BusinessUnitRemoveCustomerGroupAssignmentAction - added type
BusinessUnitSetCustomerGroupAssignmentsAction - added type
BusinessUnitSetUnitTypeAction - added type
CartDiscountSetDiscountGroupAction - added type
CartDiscountSetRecurringOrderScopeAction - added type
BestDeal - added type
CartLock - added type
CartMergeMode - added type
DiscountTypeCombination - added type
FreezeStrategy - added type
MergeCartDraft - added type
Stacking - added type
CartChangePriceRoundingModeAction - added type
CartLockCartAction - added type
CartSetCustomLineItemRecurrenceInfoAction - added type
CartSetLineItemRecurrenceInfoAction - added type
CartSetPurchaseOrderNumberAction - added type
CartUnlockCartAction - added type
AddressRole - added type
CustomerGroupAssignment - added type
CustomerGroupAssignmentDraft - added type
CustomerAddCustomerGroupAssignmentAction - added type
CustomerRemoveCustomerGroupAssignmentAction - added type
CustomerSetCustomerGroupAssignmentsAction - added type
DiscountGroup - added type
DiscountGroupDraft - added type
DiscountGroupPagedQueryResponse - added type
DiscountGroupReference - added type
DiscountGroupResourceIdentifier - added type
DiscountGroupUpdate - added type
DiscountGroupUpdateAction - added type
DiscountGroupSetDescriptionAction - added type
DiscountGroupSetIsActiveAction - added type
DiscountGroupSetKeyAction - added type
DiscountGroupSetNameAction - added type
DiscountGroupSetSortOrderAction - added type
ExactLockConflictError - added type
ExpiredCustomerEmailTokenError - added type
ExpiredCustomerPasswordTokenError - added type
MaxDiscountGroupsReachedError - added type
RecurringOrderFailureError - added type
ValidityLockConflictError - added type
GraphQLExactLockConflictError - added type
GraphQLExpiredCustomerEmailTokenError - added type
GraphQLExpiredCustomerPasswordTokenError - added type
GraphQLMaxDiscountGroupsReachedError - added type
GraphQLRecurringOrderFailureError - added type
GraphQLValidityLockConflictError - added type
BaseEvent - added type
Event - added type
CheckoutOrderCreationFailedEvent - added type
CheckoutPaymentAuthorizationCancelledEvent - added type
CheckoutPaymentAuthorizationFailedEvent - added type
CheckoutPaymentAuthorizedEvent - added type
CheckoutPaymentCancelAuthorizationFailedEvent - added type
CheckoutPaymentChargeFailedEvent - added type
CheckoutPaymentChargedEvent - added type
CheckoutPaymentRefundFailedEvent - added type
CheckoutPaymentRefundedEvent - added type
CheckoutMessageOrderPayloadBaseData - added type
CheckoutMessagePaymentsPayloadBaseData - added type
ImportContainerCreatedEventData - added type
ImportContainerDeletedEventData - added type
ImportOperationRejectedEventData - added type
ImportUnresolvedEventData - added type
ImportValidationFailedEventData - added type
ImportWaitForMasterVariantEventData - added type
ImportContainerCreatedEvent - added type
ImportContainerDeletedEvent - added type
ImportOperationRejectedEvent - added type
ImportUnresolvedEvent - added type
ImportValidationFailedEvent - added type
ImportWaitForMasterVariantEvent - added type
InventoryEntrySetInventoryLimitsAction - added type
MyPaymentSetMethodInfoCustomFieldAction - added type
MyPaymentSetMethodInfoCustomTypeAction - added type
MyPaymentSetMethodInfoInterfaceAccountAction - added type
AssociateRoleNameSetMessage - added type
BusinessUnitCustomerGroupAssignmentAddedMessage - added type
BusinessUnitCustomerGroupAssignmentRemovedMessage - added type
BusinessUnitCustomerGroupAssignmentsSetMessage - added type
BusinessUnitTopLevelUnitSetMessage - added type
BusinessUnitTypeSetMessage - added type
CartFrozenMessage - added type
CartPurchaseOrderNumberSetMessage - added type
CartUnfrozenMessage - added type
CustomerBillingAddressAddedMessage - added type
CustomerBillingAddressRemovedMessage - added type
CustomerDefaultBillingAddressSetMessage - added type
CustomerDefaultShippingAddressSetMessage - added type
CustomerExternalIdSetMessage - added type
CustomerGroupAssignmentAddedMessage - added type
CustomerGroupAssignmentRemovedMessage - added type
CustomerGroupAssignmentsSetMessage - added type
CustomerShippingAddressAddedMessage - added type
CustomerShippingAddressRemovedMessage - added type
CustomerStoresSetMessage - added type
DiscountGroupCreatedMessage - added type
DiscountGroupDeletedMessage - added type
DiscountGroupIsActiveSetMessage - added type
DiscountGroupKeySetMessage - added type
DiscountGroupSortOrderSetMessage - added type
OrderBusinessUnitSetMessage - added type
OrderCreatedFromRecurringOrderMessage - added type
OrderPaymentRemovedMessage - added type
PaymentInterfaceIdSetMessage - added type
PaymentMethodCreatedMessage - added type
PaymentMethodCustomFieldAddedMessage - added type
PaymentMethodCustomFieldChangedMessage - added type
PaymentMethodCustomFieldRemovedMessage - added type
PaymentMethodCustomTypeRemovedMessage - added type
PaymentMethodCustomTypeSetMessage - added type
PaymentMethodDefaultSetMessage - added type
PaymentMethodDeletedMessage - added type
PaymentMethodInfoCustomFieldAddedMessage - added type
PaymentMethodInfoCustomFieldChangedMessage - added type
PaymentMethodInfoCustomFieldRemovedMessage - added type
PaymentMethodInfoCustomTypeRemovedMessage - added type
PaymentMethodInfoCustomTypeSetMessage - added type
PaymentMethodInfoInterfaceAccountSetMessage - added type
PaymentMethodInfoInterfaceSetMessage - added type
PaymentMethodInfoMethodSetMessage - added type
PaymentMethodInfoNameSetMessage - added type
PaymentMethodInfoTokenSetMessage - added type
PaymentMethodInterfaceAccountSetMessage - added type
PaymentMethodKeySetMessage - added type
PaymentMethodMethodSetMessage - added type
PaymentMethodNameSetMessage - added type
PaymentMethodPaymentInterfaceSetMessage - added type
PaymentMethodPaymentMethodStatusSetMessage - added type
PaymentTransactionInterfaceIdSetMessage - added type
RecurringOrderCreatedMessage - added type
RecurringOrderCustomFieldAddedMessage - added type
RecurringOrderCustomFieldChangedMessage - added type
RecurringOrderCustomFieldRemovedMessage - added type
RecurringOrderCustomTypeRemovedMessage - added type
RecurringOrderCustomTypeSetMessage - added type
RecurringOrderDeletedMessage - added type
RecurringOrderExpiresAtSetMessage - added type
RecurringOrderFailedMessage - added type
RecurringOrderKeySetMessage - added type
RecurringOrderScheduleSetMessage - added type
RecurringOrderStartsAtSetMessage - added type
RecurringOrderStateChangedMessage - added type
RecurringOrderStateTransitionMessage - added type
AssociateRoleNameSetMessagePayload - added type
BusinessUnitCustomerGroupAssignmentAddedMessagePayload - added type
BusinessUnitCustomerGroupAssignmentRemovedMessagePayload - added type
BusinessUnitCustomerGroupAssignmentsSetMessagePayload - added type
BusinessUnitTopLevelUnitSetMessagePayload - added type
BusinessUnitTypeSetMessagePayload - added type
CartFrozenMessagePayload - added type
CartPurchaseOrderNumberSetMessagePayload - added type
CartUnfrozenMessagePayload - added type
CustomerBillingAddressAddedMessagePayload - added type
CustomerBillingAddressRemovedMessagePayload - added type
CustomerDefaultBillingAddressSetMessagePayload - added type
CustomerDefaultShippingAddressSetMessagePayload - added type
CustomerExternalIdSetMessagePayload - added type
CustomerGroupAssignmentAddedMessagePayload - added type
CustomerGroupAssignmentRemovedMessagePayload - added type
CustomerGroupAssignmentsSetMessagePayload - added type
CustomerShippingAddressAddedMessagePayload - added type
CustomerShippingAddressRemovedMessagePayload - added type
CustomerStoresSetMessagePayload - added type
DiscountGroupCreatedMessagePayload - added type
DiscountGroupDeletedMessagePayload - added type
DiscountGroupIsActiveSetMessagePayload - added type
DiscountGroupKeySetMessagePayload - added type
DiscountGroupSortOrderSetMessagePayload - added type
OrderBusinessUnitSetMessagePayload - added type
OrderCreatedFromRecurringOrderMessagePayload - added type
OrderPaymentRemovedMessagePayload - added type
PaymentInterfaceIdSetMessagePayload - added type
PaymentMethodCreatedMessagePayload - added type
PaymentMethodCustomFieldAddedMessagePayload - added type
PaymentMethodCustomFieldChangedMessagePayload - added type
PaymentMethodCustomFieldRemovedMessagePayload - added type
PaymentMethodCustomTypeRemovedMessagePayload - added type
PaymentMethodCustomTypeSetMessagePayload - added type
PaymentMethodDefaultSetMessagePayload - added type
PaymentMethodDeletedMessagePayload - added type
PaymentMethodInfoCustomFieldAddedMessagePayload - added type
PaymentMethodInfoCustomFieldChangedMessagePayload - added type
PaymentMethodInfoCustomFieldRemovedMessagePayload - added type
PaymentMethodInfoCustomTypeRemovedMessagePayload - added type
PaymentMethodInfoCustomTypeSetMessagePayload - added type
PaymentMethodInfoInterfaceAccountSetMessagePayload - added type
PaymentMethodInfoInterfaceSetMessagePayload - added type
PaymentMethodInfoMethodSetMessagePayload - added type
PaymentMethodInfoNameSetMessagePayload - added type
PaymentMethodInfoTokenSetMessagePayload - added type
PaymentMethodInterfaceAccountSetMessagePayload - added type
PaymentMethodKeySetMessagePayload - added type
PaymentMethodMethodSetMessagePayload - added type
PaymentMethodNameSetMessagePayload - added type
PaymentMethodPaymentInterfaceSetMessagePayload - added type
PaymentMethodPaymentMethodStatusSetMessagePayload - added type
PaymentTransactionInterfaceIdSetMessagePayload - added type
RecurringOrderCreatedMessagePayload - added type
RecurringOrderCustomFieldAddedMessagePayload - added type
RecurringOrderCustomFieldChangedMessagePayload - added type
RecurringOrderCustomFieldRemovedMessagePayload - added type
RecurringOrderCustomTypeRemovedMessagePayload - added type
RecurringOrderCustomTypeSetMessagePayload - added type
RecurringOrderDeletedMessagePayload - added type
RecurringOrderExpiresAtSetMessagePayload - added type
RecurringOrderFailedMessagePayload - added type
RecurringOrderKeySetMessagePayload - added type
RecurringOrderScheduleSetMessagePayload - added type
RecurringOrderStartsAtSetMessagePayload - added type
RecurringOrderStateChangedMessagePayload - added type
RecurringOrderStateTransitionMessagePayload - added type
StagedOrderChangePriceRoundingModeAction - added type
StagedOrderSetBusinessUnitAction - added type
OrderSetBusinessUnitAction - added type
PaymentMethod - added type
PaymentMethodDraft - added type
PaymentMethodPagedQueryResponse - added type
PaymentMethodReference - added type
PaymentMethodStatus - added type
PaymentMethodToken - added type
PaymentMethodUpdate - added type
PaymentMethodUpdateAction - added type
PaymentMethodSetCustomFieldAction - added type
PaymentMethodSetCustomTypeAction - added type
PaymentMethodSetDefaultAction - added type
PaymentMethodSetInterfaceAccountAction - added type
PaymentMethodSetKeyAction - added type
PaymentMethodSetMethodAction - added type
PaymentMethodSetNameAction - added type
PaymentMethodSetPaymentInterfaceAction - added type
PaymentMethodSetPaymentMethodStatusAction - added type
PaymentMethodInfoDraft - added type
PaymentSetMethodInfoAction - added type
PaymentSetMethodInfoCustomFieldAction - added type
PaymentSetMethodInfoCustomTypeAction - added type
PaymentSetMethodInfoInterfaceAccountAction - added type
PaymentSetMethodInfoTokenAction - added type
PaymentSetTransactionInterfaceIdAction - added type
ProductSearchFacetResultStats - added type
ProductSearchFacetStatsExpression - added type
ProductSearchFacetStatsValue - added type
ProductTailoringSetProductAttributeAction - added type
AttributeLevelEnum - added type
ProductSetProductAttributeAction - added type
DiscountCombinationMode - added type
DiscountsConfiguration - added type
ProjectChangePriceRoundingModeAction - added type
ProjectChangeTaxRoundingModeAction - added type
ProjectSetDiscountsConfigurationAction - added type
DayOfMonthSchedule - added type
DayOfMonthScheduleDraft - added type
IntervalUnit - added type
RecurrencePolicy - added type
RecurrencePolicyDraft - added type
RecurrencePolicyPagedQueryResponse - added type
RecurrencePolicyReference - added type
RecurrencePolicyResourceIdentifier - added type
RecurrencePolicySchedule - added type
RecurrencePolicyScheduleDraft - added type
RecurrencePolicyUpdate - added type
RecurrencePolicyUpdateAction - added type
StandardSchedule - added type
StandardScheduleDraft - added type
RecurrencePolicySetDescriptionAction - added type
RecurrencePolicySetKeyAction - added type
RecurrencePolicySetNameAction - added type
RecurrencePolicySetScheduleAction - added type
Counter - added type
CounterDraft - added type
CustomLineItemRecurrenceInfo - added type
CustomLineItemRecurrenceInfoDraft - added type
LineItemRecurrenceInfo - added type
LineItemRecurrenceInfoDraft - added type
PriceSelectionMode - added type
RecurringOrder - added type
RecurringOrderActive - added type
RecurringOrderCanceled - added type
RecurringOrderDraft - added type
RecurringOrderExpired - added type
RecurringOrderPagedQueryResponse - added type
RecurringOrderPaused - added type
RecurringOrderReference - added type
RecurringOrderResourceIdentifier - added type
RecurringOrderState - added type
RecurringOrderStateDraft - added type
RecurringOrderUpdate - added type
RecurringOrderUpdateAction - added type
SkipConfiguration - added type
SkipConfigurationDraft - added type
AnyOrder - added type
AnyOrderDraft - added type
ApplicableRecurrencePolicies - added type
ApplicableRecurrencePoliciesDraft - added type
NonRecurringOrdersOnly - added type
NonRecurringOrdersOnlyDraft - added type
RecurringOrderScope - added type
RecurringOrderScopeDraft - added type
RecurringOrdersOnly - added type
RecurringOrdersOnlyDraft - added type
RecurringOrderSetCustomFieldAction - added type
RecurringOrderSetCustomTypeAction - added type
RecurringOrderSetExpiresAtAction - added type
RecurringOrderSetKeyAction - added type
RecurringOrderSetOrderSkipConfigurationAction - added type
RecurringOrderSetScheduleAction - added type
RecurringOrderSetStartsAtAction - added type
RecurringOrderSetStateAction - added type
RecurringOrderTransitionStateAction - added type
SearchFuzzyExpression - added type
SearchFuzzyValue - added type
ShoppingListSetBusinessUnitAction - added type
EventDeliveryPayload - added type
EventSubscription - added type
EventSubscriptionResourceTypeId - added type
EventType - added type
SubscriptionNotification - added type
SubscriptionSetEventsAction
Changed Type(s)
⚠️ changed typeDeliveryPayloadfrom typeobjecttoSubscriptionNotification
Deprecated Type(s)
- type
ProductLegacySetSkuActionis removed
Added Method(s)
- added method
$apiRoot->withProjectKey()->discountGroups()->get() - added method
$apiRoot->withProjectKey()->discountGroups()->head() - added method
$apiRoot->withProjectKey()->discountGroups()->post() - added method
$apiRoot->withProjectKey()->paymentMethods()->get() - added method
$apiRoot->withProjectKey()->paymentMethods()->head() - added method
$apiRoot->withProjectKey()->paymentMethods()->post() - added method
$apiRoot->withProjectKey()->recurringOrders()->get() - added method
$apiRoot->withProjectKey()->recurringOrders()->head() - added method
$apiRoot->withProjectKey()->recurringOrders()->post() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->get() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->head() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->post() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->get() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->head() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->post() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withKey()->get() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withKey()->head() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withKey()->post() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withKey()->delete() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withId()->get() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withId()->head() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withId()->post() - added method
$apiRoot->withProjectKey()->asAssociate()->withAssociateIdValue()->inBusinessUnitKeyWithBusinessUnitKeyValue()->shoppingLists()->withId()->delete() - added method
$apiRoot->withProjectKey()->businessUnits()->keyWithKeyValueAssociatesWithAssociateIdValue()->get() - added method
$apiRoot->withProjectKey()->businessUnits()->withBusinessUnitIdValueAssociatesWithAssociateIdValue()->get() - added method
$apiRoot->withProjectKey()->carts()->customerIdWithCustomerIdValueMerge()->post() - added method
$apiRoot->withProjectKey()->discountGroups()->withKey()->get() - added method
$apiRoot->withProjectKey()->discountGroups()->withKey()->head() - added method
$apiRoot->withProjectKey()->discountGroups()->withKey()->post() - added method
$apiRoot->withProjectKey()->discountGroups()->withKey()->delete() - added method
$apiRoot->withProjectKey()->discountGroups()->withId()->get() - added method
$apiRoot->withProjectKey()->discountGroups()->withId()->head() - added method
$apiRoot->withProjectKey()->discountGroups()->withId()->post() - added method
$apiRoot->withProjectKey()->discountGroups()->withId()->delete() - added method
$apiRoot->withProjectKey()->paymentMethods()->withKey()->get() - added method
$apiRoot->withProjectKey()->paymentMethods()->withKey()->head() - added method
$apiRoot->withProjectKey()->paymentMethods()->withKey()->post() - added method
$apiRoot->withProjectKey()->paymentMethods()->withKey()->delete() - added method
$apiRoot->withProjectKey()->paymentMethods()->withId()->get() - added method
$apiRoot->withProjectKey()->paymentMethods()->withId()->head() - added method
$apiRoot->withProjectKey()->paymentMethods()->withId()->post() - added method
$apiRoot->withProjectKey()->paymentMethods()->withId()->delete() - added method
$apiRoot->withProjectKey()->recurringOrders()->withId()->get() - added method
$apiRoot->withProjectKey()->recurringOrders()->withId()->head() - added method
$apiRoot->withProjectKey()->recurringOrders()->withId()->post() - added method
$apiRoot->withProjectKey()->recurringOrders()->withId()->delete() - added method
$apiRoot->withProjectKey()->recurringOrders()->withKey()->get() - added method
$apiRoot->withProjectKey()->recurringOrders()->withKey()->head() - added method
$apiRoot->withProjectKey()->recurringOrders()->withKey()->post() - added method
$apiRoot->withProjectKey()->recurringOrders()->withKey()->delete() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withKey()->get() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withKey()->head() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withKey()->post() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withKey()->delete() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withId()->get() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withId()->head() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withId()->post() - added method
$apiRoot->withProjectKey()->recurrencePolicies()->withId()->delete() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->get() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->head() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->post() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withKey()->get() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withKey()->head() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withKey()->post() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withKey()->delete() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withId()->get() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withId()->head() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withId()->post() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withId()->delete() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->keyWithKeyValueAssociatesWithAssociateIdValue()->get() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->businessUnits()->withBusinessUnitIdValueAssociatesWithAssociateIdValue()->get() - added method
$apiRoot->withProjectKey()->inStoreKeyWithStoreKeyValue()->carts()->customerIdWithCustomerIdValueMerge()->post()
Import changes
Added Resource(s)
- added resource
/{projectKey}/business-units - added resource
/{projectKey}/product-selections - added resource
/{projectKey}/business-units/import-containers - added resource
/{projectKey}/business-units/import-containers/{importContainerKey} - added resource
/{projectKey}/product-selections/import-containers - added resource
/{projectKey}/product-selections/import-containers/{importContainerKey}
Added Enum(s)
- added enum
business-unitto typeImportResourceType - added enum
product-selectionto typeImportResourceType - added enum
associate-roleto typeReferenceType - added enum
business-unitto typeReferenceType - added enum
partiallyImportedto typeProcessingState
Changed Property(s)
⚠️ changed propertyvalueof typeMoneySetFieldfrom typeMoney[]toTypedMoney[]⚠️ changed propertycountryof typeExternalTaxRateDraftfrom typestringtoCountryCode
Removed Property(s)
⚠️ removed property/^[a-z]{2}(-[A-Z]{2})?$/from typeSearchKeywords⚠️ removed property/^[a-z]{2}(-[A-Z]{2})?$/from typeLocalizedString
Added Property(s)
- added property
/^[a-zA-Z]{2,3}(?:-[a-zA-Z]{4})?(?:-(?:[a-zA-Z]{2}|\d{3}))?$/to typeLocalizedString - added property
retentionPolicyto typeImportContainer - added property
expiresAtto typeImportContainer - added property
retentionPolicyto typeImportContainerDraft - added property
partiallyImportedto typeOperationStates - added property
attributesto typeProductDraftImport - added property
/^[a-zA-Z]{2,3}(?:-[a-zA-Z]{4})?(?:-(?:[a-zA-Z]{2}|\d{3}))?$/to typeSearchKeywords - added property
attributesto typeProductImport - added property
levelto typeAttributeDefinition
Added Type(s)
- added type
AssociateRoleKeyReference - added type
BusinessUnitKeyReference - added type
StrategyEnum - added type
RetentionPolicy - added type
TimeToLiveConfig - added type
TimeToLiveRetentionPolicy - added type
ProductSelectionImportRequest - added type
BusinessUnitImportRequest - added type
AssociateRoleInheritanceMode - added type
BusinessUnitStatus - added type
BusinessUnitAssociateMode - added type
BusinessUnitApprovalRuleMode - added type
BusinessUnitStoreMode - added type
BusinessUnitType - added type
AssociateRoleAssignmentDraft - added type
AssociateDraft - added type
BusinessUnitImport - added type
CompanyBusinessUnitImport - added type
DivisionBusinessUnitImport - added type
VariantSelectionType - added type
VariantSelection - added type
VariantExclusion - added type
ProductSelectionAssignment - added type
ProductSelectionMode - added type
ProductSelectionImport - added type
AttributeLevel
Added Method(s)
- added method
$apiRoot->withProjectKeyValue()->businessUnits()->importContainers()->withImportContainerKeyValue()->post() - added method
$apiRoot->withProjectKeyValue()->productSelections()->importContainers()->withImportContainerKeyValue()->post()
History changes
Added Enum(s)
- added enum
shipping-methodto typeChangeHistoryResourceType - added enum
standalone-priceto typeChangeHistoryResourceType - added enum
addInheritedAssociateto typePlatformInitiatedChange - added enum
changeIncludedInStatisticsto typePlatformInitiatedChange - added enum
changeInheritedAssociateto typePlatformInitiatedChange - added enum
changeLastVariantIdto typePlatformInitiatedChange - added enum
changeLineItemPublishedto typePlatformInitiatedChange - added enum
changeTopLevelUnitto typePlatformInitiatedChange - added enum
removeInheritedAssociateto typePlatformInitiatedChange - added enum
setAncestorsto typePlatformInitiatedChange - added enum
setInheritedAssociatesto typePlatformInitiatedChange - added enum
setInheritedStoresto typePlatformInitiatedChange - added enum
setLineItemDeactivatedAtto typePlatformInitiatedChange - added enum
setProductCountto typePlatformInitiatedChange - added enum
setReservationsto typePlatformInitiatedChange - added enum
addShippingto typeUpdateType - added enum
addShippingRateto typeUpdateType - added enum
addZoneto typeUpdateType - added enum
changeActiveto typeUpdateType - added enum
changeApprovalRuleModeto typeUpdateType - added enum
changeCustomLineItemPriceRoundingModeto typeUpdateType - added enum
changeCustomerto typeUpdateType - added enum
changeDiscountTypeCombinationto typeUpdateType - added enum
changeIncludedInStatisticsto typeUpdateType - added enum
changeIsDefaultto typeUpdateType - added enum
changeLastVariantIdto typeUpdateType - added enum
changeLineItemPriceRoundingModeto typeUpdateType - added enum
changeLineItemPublishedto typeUpdateType - added enum
changePriceRoundingModeto typeUpdateType - added enum
changeTaxCategoryto typeUpdateType - added enum
changeTopLevelUnitto typeUpdateType - added enum
excludeProductto typeUpdateType - added enum
removeShippingto typeUpdateType - added enum
removeShippingRateto typeUpdateType - added enum
removeZoneto typeUpdateType - added enum
replaceTaxRateto typeUpdateType - added enum
revertStagedChangesto typeUpdateType - added enum
revertStagedVariantChangesto typeUpdateType - added enum
setAncestorsto typeUpdateType - added enum
setAssetKeyto typeUpdateType - added enum
setAssociatesto typeUpdateType - added enum
setBillingAddressCustomFieldto typeUpdateType - added enum
setBillingAddressCustomTypeto typeUpdateType - added enum
setBusinessUnitto typeUpdateType - added enum
setCustomLineItemDiscountedPriceto typeUpdateType - added enum
setCustomLineItemDiscountedPricePerQuantityto typeUpdateType - added enum
setCustomerGroupAssignmentsto typeUpdateType - added enum
setDeliveryAddressCustomFieldto typeUpdateType - added enum
setDeliveryAddressCustomTypeto typeUpdateType - added enum
setDeliveryCustomFieldto typeUpdateType - added enum
setDeliveryCustomTypeto typeUpdateType - added enum
setDirectDiscountsto typeUpdateType - added enum
setDiscountOnTotalPriceto typeUpdateType - added enum
setInheritedAssociatesto typeUpdateType - added enum
setInheritedStoresto typeUpdateType - added enum
setItemShippingAddressCustomFieldto typeUpdateType - added enum
setItemShippingAddressCustomTypeto typeUpdateType - added enum
setLocalizedDescriptionto typeUpdateType - added enum
setLocalizedNameto typeUpdateType - added enum
setMaxCartQuantityto typeUpdateType - added enum
setMinCartQuantityto typeUpdateType - added enum
setParcelCustomFieldto typeUpdateType - added enum
setParcelCustomTypeto typeUpdateType - added enum
setPredicateto typeUpdateType - added enum
setPriceKeyto typeUpdateType - added enum
setPriceModeto typeUpdateType - added enum
setPriceTiersto typeUpdateType - added enum
setProductAttributeto typeUpdateType - added enum
setReferencesto typeUpdateType - added enum
setReturnInfoto typeUpdateType - added enum
setReturnItemCustomFieldto typeUpdateType - added enum
setReturnItemCustomTypeto typeUpdateType - added enum
setShippingAddressCustomFieldto typeUpdateType - added enum
setShippingAddressCustomTypeto typeUpdateType - added enum
setShippingCustomFieldto typeUpdateType - added enum
setShippingCustomTypeto typeUpdateType - added enum
setShippingInfoDiscountedPriceto typeUpdateType - added enum
setShippingMethodTaxCategoryto typeUpdateType - added enum
setTaxedShippingPriceto typeUpdateType - added enum
setTransactionCustomFieldto typeUpdateType - added enum
setTransactionCustomTypeto typeUpdateType - added enum
setUnitTypeto typeUpdateType - added enum
setVariantExclusionto typeUpdateType - added enum
ApplicationStoppedByGroupBestDealto typeDiscountCodeState - added enum
CreateApprovalRulesto typePermission - added enum
UpdateApprovalRulesto typePermission - added enum
UpdateApprovalFlowsto typePermission - added enum
ViewMyShoppingListsto typePermission - added enum
ViewOthersShoppingListsto typePermission - added enum
UpdateMyShoppingListsto typePermission - added enum
UpdateOthersShoppingListsto typePermission - added enum
CreateMyShoppingListsto typePermission - added enum
CreateOthersShoppingListsto typePermission - added enum
DeleteMyShoppingListsto typePermission - added enum
DeleteOthersShoppingListsto typePermission - added enum
includeOnlyto typeProductVariantSelectionTypeEnum - added enum
includeAllExceptto typeProductVariantSelectionTypeEnum - added enum
RenegotiationAddressedto typeQuoteState - added enum
approval-flowto typeReferenceTypeId - added enum
approval-ruleto typeReferenceTypeId - added enum
attribute-groupto typeReferenceTypeId - added enum
direct-discountto typeReferenceTypeId - added enum
discount-groupto typeReferenceTypeId - added enum
payment-methodto typeReferenceTypeId - added enum
product-priceto typeReferenceTypeId - added enum
product-tailoringto typeReferenceTypeId - added enum
recurrence-policyto typeReferenceTypeId - added enum
recurring-orderto typeReferenceTypeId - added enum
standalone-priceto typeReferenceTypeId - added enum
Deliveredto typeShipmentState - added enum
Canceledto typeShipmentState - added enum
RecurringOrderStateto typeStateTypeEnum
Removed Enum(s)
⚠️ removed enumchangeAmountAuthorizedfrom typeUpdateType⚠️ removed enumsetAsssetKeyfrom typeUpdateType⚠️ removed enumFailedfrom typeQuoteState
Changed Property(s)
⚠️ changed propertynextValueof typeAddEnumValueChangefrom typeEnumValuetoCustomFieldEnumValue⚠️ changed propertynextValueof typeAddInterfaceInteractionChangefrom typeCustomFieldExpandedValuetoCustomFields⚠️ changed propertynextValueof typeAddLocalizedEnumValueChangefrom typeAttributeLocalizedEnumValuetoCustomFieldLocalizedEnumValue⚠️ changed propertypreviousValueof typeAddShoppingListLineItemChangefrom typeLineItemtoShoppingListLineItem⚠️ changed propertynextValueof typeAddShoppingListLineItemChangefrom typeLineItemtoShoppingListLineItem⚠️ changed propertywof typeAssetDimensionsfrom typeintegertonumber⚠️ changed propertyhof typeAssetDimensionsfrom typeintegertonumber⚠️ changed propertycustomerof typeAssociatefrom typeReferencetoCustomerReference⚠️ changed propertyassociateRoleof typeAssociateRoleAssignmentfrom typeKeyReferencetoAssociateRoleKeyReference⚠️ changed propertypreviousValueof typeChangeEnumValueOrderChangefrom typeEnumValue[]toCustomFieldEnumValue[]⚠️ changed propertynextValueof typeChangeEnumValueOrderChangefrom typeEnumValue[]toCustomFieldEnumValue[]⚠️ changed propertypreviousValueof typeChangeInputHintChangefrom typeTextInputHinttoTypeTextInputHint⚠️ changed propertynextValueof typeChangeInputHintChangefrom typeTextInputHinttoTypeTextInputHint⚠️ changed propertypreviousValueof typeChangeLocalizedEnumValueOrderChangefrom typeLocalizedEnumValue[]toAttributeLocalizedEnumValue[]⚠️ changed propertynextValueof typeChangeLocalizedEnumValueOrderChangefrom typeLocalizedEnumValue[]toAttributeLocalizedEnumValue[]⚠️ changed propertypreviousValueof typeChangePlainEnumValueOrderChangefrom typeEnumValue[]toAttributePlainEnumValue[]⚠️ changed propertynextValueof typeChangePlainEnumValueOrderChangefrom typeEnumValue[]toAttributePlainEnumValue[]⚠️ changed propertytypeof typeCustomFieldsfrom typeReferencetoTypeReference⚠️ changed propertyfieldsof typeCustomFieldsfrom typeobjecttoFieldContainer⚠️ changed propertymoneyof typeCustomLineItemfrom typeMoneytoTypedMoney⚠️ changed propertytotalPriceof typeCustomLineItemfrom typeMoneytoCentPrecisionMoney⚠️ changed propertyquantityof typeCustomLineItemfrom typeintegertonumber⚠️ changed propertycreatedAtof typeDeliveryfrom typestringtodatetime⚠️ changed propertyquantityof typeDeliveryItemfrom typeintegertonumber⚠️ changed propertydiscountCodeof typeDiscountCodeInfofrom typeReferencetoDiscountCodeReference⚠️ changed propertydiscountedAmountof typeDiscountedLineItemPortionfrom typeMoneytoTypedMoney⚠️ changed propertyvalueof typeDiscountedLineItemPricefrom typeMoneytoTypedMoney⚠️ changed propertyquantityof typeDiscountedLineItemPriceForQuantityfrom typeintegertonumber⚠️ changed propertyinputHintof typeFieldDefinitionfrom typeTextInputHinttoTypeTextInputHint⚠️ changed propertywof typeImageDimensionsfrom typeintegertonumber⚠️ changed propertyhof typeImageDimensionsfrom typeintegertonumber⚠️ changed propertycustomerof typeInheritedAssociatefrom typeReferencetoCustomerReference⚠️ changed propertyassociateRoleof typeInheritedAssociateRoleAssignmentfrom typeKeyReferencetoAssociateRoleKeyReference⚠️ changed propertysourceof typeInheritedAssociateRoleAssignmentfrom typeKeyReferencetoBusinessUnitKeyReference⚠️ changed propertyquantityof typeItemShippingTargetfrom typeintegertonumber⚠️ changed propertyquantityof typeItemStatefrom typeintegertonumber⚠️ changed propertystateof typeItemStatefrom typeReferencetoStateReference⚠️ changed propertyproductTypeof typeLineItemfrom typeReferencetoProductTypeReference⚠️ changed propertyvariantof typeLineItemfrom typeVarianttoProductVariant⚠️ changed propertyquantityof typeLineItemfrom typeintegertonumber⚠️ changed propertyaddedAtof typeLineItemfrom typestringtodatetime⚠️ changed propertycentAmountof typeMoneyfrom typeintegertonumber⚠️ changed propertycreatedAtof typeParcelfrom typestringtodatetime⚠️ changed propertyheightInMillimeterof typeParcelMeasurementsfrom typeintegertonumber⚠️ changed propertylengthInMillimeterof typeParcelMeasurementsfrom typeintegertonumber⚠️ changed propertywidthInMillimeterof typeParcelMeasurementsfrom typeintegertonumber⚠️ changed propertyweightInGramof typeParcelMeasurementsfrom typeintegertonumber⚠️ changed propertypaymentsof typePaymentInfofrom typeReference[]toPaymentReference[]⚠️ changed propertyvalueof typePricefrom typeMoneytoTypedMoney⚠️ changed propertyproductSelectionof typeProductSelectionSettingfrom typeReferencetoProductSelectionReference⚠️ changed propertyrestockableInDaysof typeProductVariantAvailabilityfrom typeintegertonumber⚠️ changed propertyavailableQuantityof typeProductVariantAvailabilityfrom typeintegertonumber⚠️ changed propertyrestockableInDaysof typeProductVariantChannelAvailabilityfrom typeintegertonumber⚠️ changed propertyavailableQuantityof typeProductVariantChannelAvailabilityfrom typeintegertonumber⚠️ changed propertypreviousValueof typeRemoveDeliveryItemsChangefrom typeDeliverytoDeliveryChangeValue⚠️ changed propertypreviousValueof typeRemoveEnumValuesChangefrom typeEnumValuetoAttributePlainEnumValue⚠️ changed propertypreviousValueof typeRemoveLocalizedEnumValuesChangefrom typeLocalizedEnumValuetoAttributeLocalizedEnumValue⚠️ changed propertypreviousValueof typeRemoveShoppingListLineItemChangefrom typeLineItemtoShoppingListLineItem⚠️ changed propertynextValueof typeRemoveShoppingListLineItemChangefrom typeLineItemtoShoppingListLineItem⚠️ changed propertyreturnDateof typeReturnInfofrom typestringtodatetime⚠️ changed propertyquantityof typeReturnItemfrom typeintegertonumber⚠️ changed propertylastModifiedAtof typeReturnItemfrom typestringtodatetime⚠️ changed propertycreatedAtof typeReturnItemfrom typestringtodatetime⚠️ changed propertyaverageRatingof typeReviewRatingStatisticsfrom typeintegertonumber⚠️ changed propertyhighestRatingof typeReviewRatingStatisticsfrom typeintegertonumber⚠️ changed propertylowestRatingof typeReviewRatingStatisticsfrom typeintegertonumber⚠️ changed propertypreviousValueof typeSetAttributeChangefrom typeAttributeValuetoAttribute⚠️ changed propertynextValueof typeSetAttributeChangefrom typeAttributeValuetoAttribute⚠️ changed propertypreviousValueof typeSetCustomLineItemTaxedPriceChangefrom typeMoneytoTaxedItemPrice⚠️ changed propertynextValueof typeSetCustomLineItemTaxedPriceChangefrom typeMoneytoTaxedItemPrice⚠️ changed propertypreviousValueof typeSetDiscountedPriceChangefrom typePricetoDiscountedPrice⚠️ changed propertynextValueof typeSetDiscountedPriceChangefrom typePricetoDiscountedPrice⚠️ changed propertypreviousValueof typeSetOrderTaxedPriceChangefrom typeTaxedItemPricetoTaxedPrice⚠️ changed propertynextValueof typeSetOrderTaxedPriceChangefrom typeTaxedItemPricetoTaxedPrice⚠️ changed propertypreviousValueof typeSetShippingInfoTaxedPriceChangefrom typeTaxedPricetoTaxedItemPrice⚠️ changed propertynextValueof typeSetShippingInfoTaxedPriceChangefrom typeTaxedPricetoTaxedItemPrice⚠️ changed propertypreviousValueof typeSetShippingRateChangefrom typeMoneytoShippingRate⚠️ changed propertynextValueof typeSetShippingRateChangefrom typeMoneytoShippingRate⚠️ changed propertypreviousValueof typeSetStoreChangefrom typeReferencetoKeyReference⚠️ changed propertynextValueof typeSetStoreChangefrom typeReferencetoKeyReference⚠️ changed propertypriceof typeShippingRatefrom typeMoneytoCentPrecisionMoney⚠️ changed propertyfreeAboveof typeShippingRatefrom typeMoneytoCentPrecisionMoney⚠️ changed propertyamountof typeSubRatefrom typeintegertonumber⚠️ changed propertychannelof typeSyncInfofrom typeReferencetoChannelReference⚠️ changed propertysyncedAtof typeSyncInfofrom typestringtodatetime⚠️ changed propertyamountof typeTaxRatefrom typeintegertonumber⚠️ changed propertytotalNetof typeTaxedItemPricefrom typeMoneytoCentPrecisionMoney⚠️ changed propertytotalGrossof typeTaxedItemPricefrom typeMoneytoCentPrecisionMoney⚠️ changed propertytotalNetof typeTaxedPricefrom typeMoneytoCentPrecisionMoney⚠️ changed propertytotalGrossof typeTaxedPricefrom typeMoneytoCentPrecisionMoney⚠️ changed propertyaddedAtof typeTextLineItemfrom typestringtodatetime⚠️ changed propertyquantityof typeTextLineItemfrom typeintegertonumber⚠️ changed propertytimestampof typeTransactionfrom typestringtodatetime⚠️ changed propertyamountof typeTransactionfrom typeMoneytoCentPrecisionMoney
Required Property(s)
- changed property
idof typeAddressto be optional - changed property
keyof typeAddressto be optional - changed property
titleof typeAddressto be optional - changed property
salutationof typeAddressto be optional - changed property
firstNameof typeAddressto be optional - changed property
lastNameof typeAddressto be optional - changed property
streetNameof typeAddressto be optional - changed property
streetNumberof typeAddressto be optional - changed property
additionalStreetInfoof typeAddressto be optional - changed property
postalCodeof typeAddressto be optional - changed property
cityof typeAddressto be optional - changed property
regionof typeAddressto be optional - changed property
stateof typeAddressto be optional - changed property
companyof typeAddressto be optional - changed property
departmentof typeAddressto be optional - changed property
buildingof typeAddressto be optional - changed property
apartmentof typeAddressto be optional - changed property
pOBoxof typeAddressto be optional - changed property
phoneof typeAddressto be optional - changed property
mobileof typeAddressto be optional - changed property
emailof typeAddressto be optional - changed property
faxof typeAddressto be optional - changed property
additionalAddressInfoof typeAddressto be optional - changed property
externalIdof typeAddressto be optional - changed property
descriptionof typeAssetto be optional - changed property
customof typeAssetto be optional - changed property
keyof typeAssetto be optional - changed property
keyof typeAssetSourceto be optional - changed property
dimensionsof typeAssetSourceto be optional - changed property
contentTypeof typeAssetSourceto be optional - changed property
inputTipof typeAttributeDefinitionto be optional - changed property
taxedPriceof typeCustomLineItemto be optional - changed property
inputHintof typeFieldDefinitionto be optional - changed property
labelof typeImageto be optional - changed property
productSlugof typeLineItemto be optional - changed property
customof typeLineItemto be optional - changed property
addedAtof typeLineItemto be optional - changed property
stateof typeLocationto be optional - changed property
measurementsof typeParcelto be optional - changed property
trackingDataof typeParcelto be optional - changed property
itemsof typeParcelto be optional - changed property
heightInMillimeterof typeParcelMeasurementsto be optional - changed property
lengthInMillimeterof typeParcelMeasurementsto be optional - changed property
widthInMillimeterof typeParcelMeasurementsto be optional - changed property
weightInGramof typeParcelMeasurementsto be optional - changed property
channelsof typeProductVariantAvailabilityto be optional - changed property
isOnStockof typeProductVariantAvailabilityto be optional - changed property
restockableInDaysof typeProductVariantAvailabilityto be optional - changed property
availableQuantityof typeProductVariantAvailabilityto be optional - changed property
isOnStockof typeProductVariantChannelAvailabilityto be optional - changed property
restockableInDaysof typeProductVariantChannelAvailabilityto be optional - changed property
availableQuantityof typeProductVariantChannelAvailabilityto be optional - changed property
idof typeResourceIdentifierto be optional - changed property
keyof typeResourceIdentifierto be optional - changed property
returnTrackingIdof typeReturnInfoto be optional - changed property
returnDateof typeReturnInfoto be optional - changed property
commentof typeReturnItemto be optional - changed property
suggestTokenizerof typeSearchKeywordto be optional - changed property
freeAboveof typeShippingRateto be optional - changed property
isMatchingof typeShippingRateto be optional - changed property
externalIdof typeSyncInfoto be optional - changed property
idof typeTaxRateto be optional - changed property
stateof typeTaxRateto be optional - changed property
subRatesof typeTaxRateto be optional - changed property
customof typeTextLineItemto be optional - changed property
descriptionof typeTextLineItemto be optional - changed property
trackingIdof typeTrackingDatato be optional - changed property
carrierof typeTrackingDatato be optional - changed property
providerof typeTrackingDatato be optional - changed property
providerTransactionof typeTrackingDatato be optional - changed property
isReturnof typeTrackingDatato be optional - changed property
timestampof typeTransactionto be optional - changed property
interactionIdof typeTransactionto be optional ⚠️ changed propertytriggerPatternof typeChangeTargetPatternChangeValueto be required
Removed Property(s)
⚠️ removed property/^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/from typeCategoryOrderHints⚠️ removed propertyvariantIdfrom typeLineItem⚠️ removed propertyfractionDigitsfrom typeMoney⚠️ removed propertytypefrom typeMoney⚠️ removed property//from typeProductVariantChannelAvailabilityMap⚠️ removed propertyskusfrom typeProductVariantSelection
Added Property(s)
- added property
catalogDatato typeAddAssetChange - added property
variantto typeAddAssetChange - added property
attributeNameto typeAddEnumValueChange - added property
variantto typeAddExternalImageChange - added property
variantto typeAddPriceChange - added property
catalogDatato typeAddToCategoryChange - added property
customto typeAddress - added property
sourcesto typeAsset - added property
tagsto typeAsset - added property
rolesto typeAssociate - added property
levelto typeAttributeDefinition - added property
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/to typeCategoryOrderHints - added property
catalogDatato typeChangeAssetNameChange - added property
variantto typeChangeAssetNameChange - added property
catalogDatato typeChangeAssetOrderChange - added property
variantto typeChangeAssetOrderChange - added property
addedItemsto typeChangeCartDiscountsChange - added property
removedItemsto typeChangeCartDiscountsChange - added property
attributeNameto typeChangeEnumValueLabelChange - added property
attributeNameto typeChangeEnumValueOrderChange - added property
addedItemsto typeChangeGroupsChange - added property
removedItemsto typeChangeGroupsChange - added property
variantto typeChangePriceChange - added property
catalogDatato typeChangeSlugChange - added property
keyto typeCustomLineItem - added property
taxedPricePortionsto typeCustomLineItem - added property
stateto typeCustomLineItem - added property
taxCategoryto typeCustomLineItem - added property
taxRateto typeCustomLineItem - added property
perMethodTaxRateto typeCustomLineItem - added property
discountedPricePerQuantityto typeCustomLineItem - added property
customto typeCustomLineItem - added property
shippingDetailsto typeCustomLineItem - added property
priceModeto typeCustomLineItem - added property
recurrenceInfoto typeCustomLineItem - added property
keyto typeDelivery - added property
requiredto typeFieldDefinition - added property
shippingMethodKeyto typeItemShippingTarget - added property
keyto typeLineItem - added property
productKeyto typeLineItem - added property
priceto typeLineItem - added property
totalPriceto typeLineItem - added property
discountedPricePerQuantityto typeLineItem - added property
taxedPriceto typeLineItem - added property
taxedPricePortionsto typeLineItem - added property
stateto typeLineItem - added property
taxRateto typeLineItem - added property
perMethodTaxRateto typeLineItem - added property
supplyChannelto typeLineItem - added property
distributionChannelto typeLineItem - added property
priceModeto typeLineItem - added property
lineItemModeto typeLineItem - added property
inventoryModeto typeLineItem - added property
shippingDetailsto typeLineItem - added property
lastModifiedAtto typeLineItem - added property
recurrenceInfoto typeLineItem - added property
variantto typeMoveImageToPositionChange - added property
keyto typeParcel - added property
customto typeParcel - added property
keyto typePrice - added property
countryto typePrice - added property
customerGroupto typePrice - added property
channelto typePrice - added property
validFromto typePrice - added property
validUntilto typePrice - added property
discountedto typePrice - added property
tiersto typePrice - added property
customto typePrice - added property
recurrencePolicyto typePrice - added property
idto typeProductVariantAvailability - added property
versionto typeProductVariantAvailability - added property
idto typeProductVariantChannelAvailability - added property
versionto typeProductVariantChannelAvailability - added property
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/to typeProductVariantChannelAvailabilityMap - added property
catalogDatato typeRemoveAssetChange - added property
variantto typeRemoveAssetChange - added property
catalogDatato typeRemoveFromCategoryChange - added property
variantto typeRemoveImageChange - added property
variantto typeRemovePriceChange - added property
keyto typeReturnItem - added property
customto typeReturnItem - added property
catalogDatato typeSetAssetCustomFieldChange - added property
variantto typeSetAssetCustomFieldChange - added property
catalogDatato typeSetAssetCustomTypeChange - added property
variantto typeSetAssetCustomTypeChange - added property
catalogDatato typeSetAssetDescriptionChange - added property
variantto typeSetAssetDescriptionChange - added property
catalogDatato typeSetAssetKeyChange - added property
variantto typeSetAssetKeyChange - added property
catalogDatato typeSetAssetSourcesChange - added property
variantto typeSetAssetSourcesChange - added property
catalogDatato typeSetAssetTagsChange - added property
variantto typeSetAssetTagsChange - added property
variantto typeSetAttributeChange - added property
addedItemsto typeSetChannelRolesChange - added property
removedItemsto typeSetChannelRolesChange - added property
addedItemsto typeSetCountriesChange - added property
removedItemsto typeSetCountriesChange - added property
customTypeIdto typeSetCustomLineItemCustomFieldChange - added property
customLineItemto typeSetCustomLineItemShippingDetailsChange - added property
priceto typeSetDiscountedPriceChange - added property
addedItemsto typeSetDistributionChannelsChange - added property
removedItemsto typeSetDistributionChannelsChange - added property
variantto typeSetImageLabelChange - added property
addedItemsto typeSetLanguagesChange - added property
removedItemsto typeSetLanguagesChange - added property
lineItemIdto typeSetLineItemDiscountedPriceChange - added property
lineItemIdto typeSetLineItemDiscountedPricePerQuantityChange - added property
lineItemIdto typeSetLineItemPriceChange - added property
lineItemIdto typeSetLineItemProductSlugChange - added property
lineItemto typeSetLineItemShippingDetailsChange - added property
variantto typeSetLineItemShippingDetailsChange - added property
lineItemIdto typeSetLineItemTaxAmountChange - added property
lineItemIdto typeSetLineItemTaxRateChange - added property
variantto typeSetLineItemTaxedPriceChange - added property
lineItemIdto typeSetLineItemTotalPriceChange - added property
variantto typeSetLineItemTotalPriceChange - added property
catalogDatato typeSetMetaDescriptionChange - added property
catalogDatato typeSetMetaKeywordsChange - added property
catalogDatato typeSetMetaTitleChange - added property
lineItemIdto typeSetOrderLineItemCustomFieldChange - added property
lineItemIdto typeSetOrderLineItemCustomTypeChange - added property
addedItemsto typeSetPermissionsChange - added property
removedItemsto typeSetPermissionsChange - added property
addedItemsto typeSetPricesChange - added property
removedItemsto typeSetPricesChange - added property
variantto typeSetProductPriceCustomFieldChange - added property
priceIdto typeSetProductPriceCustomFieldChange - added property
customTypeIdto typeSetProductPriceCustomFieldChange - added property
nameto typeSetProductPriceCustomFieldChange - added property
variantto typeSetProductPriceCustomTypeChange - added property
priceIdto typeSetProductPriceCustomTypeChange - added property
addedItemsto typeSetProductSelectionsChange - added property
removedItemsto typeSetProductSelectionsChange - added property
variantto typeSetProductVariantKeyChange - added property
addedItemsto typeSetReservationsChange - added property
removedItemsto typeSetReservationsChange - added property
variantto typeSetSkuChange - added property
addedItemsto typeSetStateRolesChange - added property
removedItemsto typeSetStateRolesChange - added property
addedItemsto typeSetStoresChange - added property
removedItemsto typeSetStoresChange - added property
addedItemsto typeSetSupplyChannelsChange - added property
removedItemsto typeSetSupplyChannelsChange - added property
addedItemsto typeSetTransitionsChange - added property
removedItemsto typeSetTransitionsChange - added property
keyto typeTaxRate - added property
taxPortionsto typeTaxedItemPrice - added property
totalTaxto typeTaxedItemPrice - added property
taxPortionsto typeTaxedPrice - added property
totalTaxto typeTaxedPrice - added property
keyto typeTextLineItem - added property
customto typeTransaction - added property
customLineItemIdto typeTransitionCustomLineItemStateChange
MarkDeprecated Type(s)
- marked type
AddAssociateChangeas deprecated - marked type
AddPriceChangeas deprecated - marked type
AddProductSelectionChangeas deprecated - marked type
AddStateRolesChangeas deprecated - marked type
ChangeAmountAuthorizedChangeas deprecated - marked type
RemoveAssociateChangeas deprecated - marked type
RemovePriceChangeas deprecated - marked type
RemoveProductSelectionChangeas deprecated - marked type
RemoveStateRolesChangeas deprecated
Added Type(s)
- added type
TooManyRequestsError - added type
GraphQLTooManyRequestsError - added type
DirectDiscount - added type
DiscountTypeCombination - added type
BestDeal - added type
Stacking - added type
ShippingMethodLabel - added type
AddShippingChange - added type
ChangeApprovalRuleModeChange - added type
ChangeCustomerChange - added type
ChangeIncludedInStatisticsChange - added type
ChangeLastVariantIdChange - added type
ChangeLineItemNameChange - added type
ChangeLineItemPublishedChange - added type
ExcludeProductChange - added type
RemoveShippingChange - added type
ReplaceTaxRateChange - added type
RevertStagedChangesChange - added type
RevertStagedVariantChangesChange - added type
SetAncestorsChange - added type
SetBillingAddressCustomFieldChange - added type
SetBillingAddressCustomTypeChange - added type
SetBusinessUnitChange - added type
SetCustomLineItemDiscountedPriceChange - added type
SetCustomLineItemDiscountedPricePerQuantityChange - added type
SetCustomerGroupAssignmentsChange - added type
SetDeliveryAddressCustomFieldChange - added type
SetDeliveryAddressCustomTypeChange - added type
SetDeliveryCustomFieldChange - added type
SetDeliveryCustomTypeChange - added type
SetDiscountOnTotalPriceChange - added type
SetInheritedStoresChange - added type
SetItemShippingAddressCustomFieldChange - added type
SetItemShippingAddressCustomTypeChange - added type
SetMaxCartQuantityChange - added type
SetMinCartQuantityChange - added type
SetParcelCustomFieldChange - added type
SetParcelCustomTypeChange - added type
SetPasswordChange - added type
SetPriceKeyChange - added type
SetPriceModeChange - added type
SetProductAttributeChange - added type
SetReturnInfoChange - added type
SetReturnItemCustomLineItemCustomFieldChange - added type
SetReturnItemCustomLineItemCustomTypeChange - added type
SetReturnItemLineItemCustomFieldChange - added type
SetReturnItemLineItemCustomTypeChange - added type
SetShippingAddressCustomFieldChange - added type
SetShippingAddressCustomTypeChange - added type
SetShippingCustomFieldChange - added type
SetShippingCustomTypeChange - added type
SetTransactionCustomFieldChange - added type
SetTransactionCustomTypeChange - added type
SetUnitTypeChange - added type
SetVariantExclusionChange - added type
UpdateItemShippingAddressChange - added type
SetAssociatesChange - added type
SetInheritedAssociatesChange - added type
ChangeTopLevelUnitChange - added type
Attribute - added type
BusinessUnitApprovalRuleMode - added type
BusinessUnitResourceIdentifier - added type
BusinessUnitType - added type
CustomFieldEnumValue - added type
CustomFieldLocalizedEnumValue - added type
CustomerGroupAssignment - added type
DiscountOnTotalPrice - added type
DiscountedTotalPricePortion - added type
ProductPriceModeEnum - added type
ProductVariantExclusion - added type
Shipping - added type
ShippingInfo - added type
ShippingRateInput - added type
ShoppingListLineItem - added type
TypeTextInputHint - added type
TypedMoney - added type
CentPrecisionMoney - added type
DiscountedPrice - added type
ShippingMethodState - added type
AssociateRoleDeprecated - added type
AssociateRoleKeyReference - added type
AttributeLevelEnum - added type
BaseAddress - added type
BusinessUnitKeyReference - added type
CartDiscountReference - added type
CartDiscountTarget - added type
CartDiscountValue - added type
CategoryReference - added type
ChannelReference - added type
CustomFieldValue - added type
CustomLineItemPriceMode - added type
CustomLineItemRecurrenceInfo - added type
CustomerGroupReference - added type
CustomerReference - added type
DiscountCodeReference - added type
FieldContainer - added type
GeoJson - added type
InventoryMode - added type
LineItemMode - added type
LineItemPriceMode - added type
LineItemRecurrenceInfo - added type
MethodTaxRate - added type
MethodTaxedPrice - added type
PaymentReference - added type
PriceSelectionMode - added type
PriceTier - added type
ProductDiscountReference - added type
ProductDiscountValue - added type
ProductReference - added type
ProductSelectionReference - added type
ProductTypeReference - added type
ProductVariant - added type
RecurrencePolicyReference - added type
ResourceTypeId - added type
ScopedPrice - added type
ShippingMethodReference - added type
StateReference - added type
StoreKeyReference - added type
TaxCategoryReference - added type
TaxPortion - added type
TypeReference - added type
ClientLogging - added type
ChangePriceRoundingModeChange - added type
ChangeCustomLineItemPriceRoundingModeChange - added type
ChangeLineItemPriceRoundingModeChange - added type
SetDirectDiscountsChange - added type
SetReferencesChange - added type
SetShippingInfoDiscountedPriceChange - added type
SetShippingMethodTaxCategoryChange - added type
SetTaxedShippingPriceChange - added type
ShippingMethodAddShippingRateChange - added type
ShippingMethodAddZoneChange - added type
ShippingMethodChangeActiveChange - added type
ShippingMethodChangeIsDefaultChange - added type
ShippingMethodChangeNameChange - added type
ShippingMethodChangeTaxCategoryChange - added type
ShippingMethodRemoveShippingRateChange - added type
ShippingMethodRemoveZoneChange - added type
ShippingMethodSetCustomFieldChange - added type
ShippingMethodSetCustomTypeChange - added type
ShippingMethodSetKeyChange - added type
ShippingMethodSetLocalizedDescriptionChange - added type
ShippingMethodSetLocalizedNameChange - added type
ShippingMethodSetPredicateChange - added type
ZoneResourceIdentifier - added type
ChangeDiscountTypeCombinationChange - added type
StandalonePriceChangeActiveChange - added type
StandalonePriceChangeValueChange - added type
StandalonePriceSetCustomFieldChange - added type
StandalonePriceSetCustomTypeChange - added type
StandalonePriceSetDiscountedPriceChange - added type
StandalonePriceSetKeyChange - added type
StandalonePriceSetPriceTiersChange - added type
StandalonePriceSetValidFromAndUntilChange - added type
StandalonePriceSetValidFromChange - added type
StandalonePriceSetValidUntilChange - added type
StandalonePriceLabel
Changed Type(s)
⚠️ changed typeAddressfrom typeobjecttoBaseAddress⚠️ changed typeGeoLocationfrom typeobjecttoGeoJson
Checkout changes
Added Resource(s)
- added resource
/{projectKey}/payment-integrations - added resource
/{projectKey}/applications - added resource
/{projectKey}/payment-integrations/{id} - added resource
/{projectKey}/payment-integrations/key={key} - added resource
/{projectKey}/applications/{id} - added resource
/{projectKey}/applications/key={key}
Added Enum(s)
- added enum
deploymentto typeReferenceTypeId - added enum
reversePaymentto typePaymentIntentOperation
Changed Property(s)
⚠️ changed propertyactionof typePaymentIntentCancelActionfrom typestringtoPaymentIntentOperation⚠️ changed propertyactionof typePaymentIntentCaptureActionfrom typestringtoPaymentIntentOperation⚠️ changed propertyactionof typePaymentIntentRefundActionfrom typestringtoPaymentIntentOperation⚠️ changed propertyapplicationof typeTransactionfrom typeApplicationResourceIdentifiertoApplicationReference
Required Property(s)
- changed property
detailedErrorMessageof typeInvalidJsonInputErrorto be optional ⚠️ changed propertyamountof typePaymentIntentRefundActionto be required
Removed Property(s)
⚠️ removed propertypayloadfrom typeResponseMessage⚠️ removed propertyamountfrom typePaymentIntentAction
Added Property(s)
- added property
resourceIdentifierto typeResourceNotFoundError - added property
resourceIdto typeResourceNotFoundError - added property
merchantReferenceto typePaymentIntentCancelAction - added property
merchantReferenceto typePaymentIntentCaptureAction - added property
transactionIdto typePaymentIntentRefundAction - added property
merchantReferenceto typePaymentIntentRefundAction - added property
payloadto typePaymentCancelled - added property
payloadto typePaymentFailed - added property
payloadto typePaymentValidationFailed
Changed MethodResponseBody(s)
⚠️ changed response body for400: application/jsonof methodpost /{projectKey}/transactionsfrom typenulltoErrorResponse⚠️ changed response body for400: application/jsonof methodpost /{projectKey}/payment-intents/{paymentId}from typenulltoErrorResponse⚠️ changed response body for400: application/jsonof methodget /{projectKey}/transactions/{id}from typenulltoErrorResponse⚠️ changed response body for400: application/jsonof methodget /{projectKey}/transactions/key={key}from typenulltoErrorResponse
Removed Type(s)
⚠️ removed typeNoPaymentMethods⚠️ removed typePaymentConnectorError⚠️ removed typePaymentMethodLoaded⚠️ removed typePaymentMethodLoading⚠️ removed typePaymentMethodLoadingError⚠️ removed typePaymentMethodSelected⚠️ removed typePaymentMethodSelectionConfirmation⚠️ removed typePaymentMethodSelectionConfirmationFailed⚠️ removed typePaymentMethodsReceived⚠️ removed typePaymentVerificationStarted⚠️ removed typePaymentVerificationTimeout
Added Type(s)
- added type
AllowedOrigins - added type
Application - added type
ApplicationAgreement - added type
ApplicationAgreementDraft - added type
ApplicationAgreementStatus - added type
ApplicationAgreementType - added type
ApplicationDraft - added type
ApplicationLogo - added type
ApplicationMode - added type
ApplicationStatus - added type
ApplicationUpdateAction - added type
ApplicationUpdateActions - added type
DiscountsConfiguration - added type
PaginatedApplication - added type
PaymentsConfiguration - added type
AddAllowedOriginUpdateAction - added type
AddApplicationAgreementUpdateAction - added type
AddCountryUpdateAction - added type
RemoveAllowedOriginUpdateAction - added type
RemoveApplicationAgreementUpdateAction - added type
RemoveCountryUpdateAction - added type
ReorderApplicationAgreementUpdateAction - added type
SetActivePaymentComponentTypeUpdateAction - added type
SetAllowAllOriginsUpdateAction - added type
SetAllowedOriginsUpdateAction - added type
SetApplicationAgreementNameUpdateAction - added type
SetApplicationAgreementStatusUpdateAction - added type
SetApplicationAgreementTextUpdateAction - added type
SetApplicationAgreementTypeUpdateAction - added type
SetApplicationAgreementsUpdateAction - added type
SetApplicationLogoUpdateAction - added type
SetApplicationNameUpdateAction - added type
SetApplicationStatusUpdateAction - added type
SetCountriesUpdateAction - added type
SetDescriptionUpdateAction - added type
SetDiscountsConfigurationUpdateAction - added type
SetPaymentReturnUrlUpdateAction - added type
SetPaymentsConfigurationUpdateAction - added type
CountryCode - added type
CreatedBy - added type
CurrencyCode - added type
LastModifiedBy - added type
Locale - added type
LocalizedString - added type
LocalizedUrl - added type
ConcurrentModificationError - added type
DuplicateFieldWithConflictingResourceError - added type
ErrorResponse - added type
InvalidFieldError - added type
InvalidOperationError - added type
MaxResourceLimitExceededError - added type
MissingProjectKeyError - added type
ReferencedResourceNotFoundError - added type
ServiceUnavailableError - added type
SyntaxErrorError - added type
AutomatedReversalConfiguration - added type
ConnectorDeploymentReference - added type
DisplayInfo - added type
PaginatedPaymentIntegration - added type
PaymentComponentType - added type
PaymentIntegration - added type
PaymentIntegrationDraft - added type
PaymentIntegrationStatus - added type
PaymentIntegrationType - added type
SortingInfo - added type
PaymentIntegrationUpdateAction - added type
PaymentIntegrationUpdateActions - added type
SetAutomatedReversalConfigurationPredicateUpdateAction - added type
SetAutomatedReversalConfigurationStatusUpdateAction - added type
SetAutomatedReversalConfigurationUpdateAction - added type
SetConnectorDeploymentUpdateAction - added type
SetDisplayInfoDescriptionUpdateAction - added type
SetDisplayInfoLabelUpdateAction - added type
SetDisplayInfoLogoUrlUpdateAction - added type
SetDisplayInfoPayButtonTextUpdateAction - added type
SetDisplayInfoUpdateAction - added type
SetKeyUpdateAction - added type
SetNameUpdateAction - added type
SetPredicateUpdateAction - added type
SetSortingInfoUpdateAction - added type
SetStatusUpdateAction - added type
SetTypeUpdateAction - added type
PaymentIntentReverseAction - added type
ConnectorError - added type
ErrorLoadingAllPaymentIntegrations - added type
ExpressContainerNotFound - added type
ExpressMultipleContainersFound - added type
ExpressPaymentCancelled - added type
ExpressPaymentCompleted - added type
ExpressPaymentFailed - added type
ExpressPaymentIntegrationNotAvailable - added type
ExpressPaymentInterrupted - added type
ExpressPaymentStarted - added type
FailedToRefreshSession - added type
GiftCardBalanceError - added type
GiftCardBalanceRemoved - added type
GiftCardBalanceStarted - added type
GiftCardBalanceSuccess - added type
GiftCardRedeemError - added type
GiftCardRedeemStarted - added type
GiftCardRedeemSuccess - added type
NoExpressPaymentIntegrations - added type
NoPaymentIntegrations - added type
NonOrderableCartError - added type
NotApplicableDiscountCodeRemoved - added type
OrderVerificationRetryError - added type
OrderVerificationStarted - added type
OrderVerificationTimeout - added type
PaymentIntegrationLoaded - added type
PaymentIntegrationLoading - added type
PaymentIntegrationLoadingError - added type
PaymentIntegrationNotAvailable - added type
PaymentIntegrationSelected - added type
PaymentIntegrationSelectionConfirmation - added type
PaymentIntegrationSelectionConfirmationFailed - added type
PaymentIntegrationsReceived - added type
ShippingMethodSelected - added type
ShippingMethodSelectionConfirmation
Changed Type(s)
⚠️ changed typePaymentIntentCancelActionfrom typeobjecttoPaymentIntentAction⚠️ changed typePaymentIntentCaptureActionfrom typeobjecttoPaymentIntentAction⚠️ changed typePaymentIntentRefundActionfrom typeobjecttoPaymentIntentAction⚠️ changed typePaymentCancelledfrom typeMessagetoResponseMessage⚠️ changed typePaymentFailedfrom typeMessagetoResponseMessage⚠️ changed typePaymentValidationFailedfrom typeMessagetoResponseMessage⚠️ changed typeTransactionItemfrom typeTransactionItemDrafttoobject
Added Method(s)
- added method
$apiRoot->withProjectKey()->paymentIntegrations()->get() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->post() - added method
$apiRoot->withProjectKey()->applications()->get() - added method
$apiRoot->withProjectKey()->applications()->post() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withId()->get() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withId()->head() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withId()->post() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withId()->delete() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withKey()->get() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withKey()->post() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withKey()->head() - added method
$apiRoot->withProjectKey()->paymentIntegrations()->withKey()->delete() - added method
$apiRoot->withProjectKey()->applications()->withId()->get() - added method
$apiRoot->withProjectKey()->applications()->withId()->head() - added method
$apiRoot->withProjectKey()->applications()->withId()->post() - added method
$apiRoot->withProjectKey()->applications()->withId()->delete() - added method
$apiRoot->withProjectKey()->applications()->withKey()->get() - added method
$apiRoot->withProjectKey()->applications()->withKey()->post() - added method
$apiRoot->withProjectKey()->applications()->withKey()->head() - added method
$apiRoot->withProjectKey()->applications()->withKey()->delete()
Full Changelog: 10.18.0...11.0.0