openapi: 3.0.1 info: title: Notification description: "# Notification API\n\nThe Intershop Notification REST API contains\ \ endpoints for product price and back in stock notifications.\nA price notification\ \ notifies the user when a product drops below a certain price, and a stock notification\ \ notifies a user when a product is back in stock.\n\n## Examples\n\n### Create\ \ new price notification\n\n {\n \"sku\": \"24601\",\n \"notificationMailAddress\"\ : \"mail@example.com\",\n \"price\": {\n \"value\": 12.4,\n\ \ \"currency\": \"USD\"\n }\n }\n\n### Create new back in\ \ stock notification\n\n {\n \"sku\": \"24601\",\n \"notificationMailAddress\"\ : \"mail@example.com\",\n }\n" version: 1.0.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - smb-responsive - "-" default: smb-responsive paths: /customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications: get: tags: - Notifications summary: Returns notifications endpoints description: This operation returns links to the stock and price notification endpoints of a user. operationId: getNotificationsBaseResource parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource.getNotifications() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/price: get: tags: - Price Notifications summary: Returns price notifications description: This operation returns links to the price notifications of a customer. operationId: getProductNotifications parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.getNotifications() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource post: tags: - Price Notifications summary: Creates price notification description: "This operation creates a new price notification.\n\nThe body must\ \ contain the `sku`, the `price`, and a `notificationMailAddress` to inform\ \ the user when the product price drops below this value." operationId: createPriceNotification parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/NewProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/NewProductNotificationRO' responses: "201": description: Created "401": description: Unauthorized "409": description: Conflict - A price notification for this product already exists. "404": description: |- Not found - possible values for header error-key: - account.productnotification.product.not_found.error "400": description: |- Bad request - possible values for header error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error - account.productnotification.product.in_stock.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/price/{CustomerProductPriceNotificationResourceKey}: get: tags: - Price Notifications summary: Returns price notification details description: This operation returns details about a specific price notification. operationId: getPriceNotificationDetails parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductPriceNotificationResourceKey in: path description: Price notification ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' "401": description: Unauthorized "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.getProductPriceNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource put: tags: - Price Notifications summary: Updates price notification description: |- This operation updates an existing price notification. The body must contain a `price` and a `notificationMailAddress` to inform the user when the product price drops below this value. operationId: updatePriceNotification parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductPriceNotificationResourceKey in: path description: Price notification ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found "400": description: |- Bad request possible values for header error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.updateProductPriceNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource delete: tags: - Price Notifications summary: Deletes a price notification description: This operation deletes an existing price notification. operationId: deletePriceNotification parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductPriceNotificationResourceKey in: path description: Price notification ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "204": description: No content "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.deleteProductPriceNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/stock: get: tags: - Stock Notifications summary: Returns stock notifications description: This operation returns links to the back in stock notifications of a customer. operationId: getStockNotifications parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.getNotifications() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource post: tags: - Stock Notifications summary: Creates stock notification description: |- This operation creates a new back in stock notification. The body must contain the `sku` and a `notificationMailAddress` which is used to inform the user when the product is in stock again. operationId: createStockNotification parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/NewProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/NewProductNotificationRO' responses: "201": description: Created "401": description: Unauthorized "409": description: Conflict- A stock notification for this product already exists. "404": description: |- Not found - possible values for header error-key: - account.productnotification.product.not_found.error "400": description: |- Bad request - possible values for header error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error - account.productnotification.product.in_stock.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/notifications/stock/{CustomerProductStockNotificationResourceKey}: get: tags: - Stock Notifications summary: Returns stock notification details description: This operation returns details of a specific back in stock notification. operationId: getStockNotificationDetails parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductStockNotificationResourceKey in: path description: Stock notification ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' "401": description: Unauthorized "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.getProductStockNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource put: tags: - Stock Notifications summary: Updates stock notification description: |- This operation updates an existing back in stock notification. The body must contain a `notificationMailAddress` which is used to inform the user when the product is in stock again. operationId: updateStockNotification parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductStockNotificationResourceKey in: path description: Stock notification ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found "400": description: |- Bad request possible values for headere error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.updateProductStockNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource delete: tags: - Stock Notifications summary: Deletes a stock notification description: This operation deletes an existing back in stock notification. operationId: deleteStockNotification parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductStockNotificationResourceKey in: path description: Stock notification ID required: true schema: type: string - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "204": description: No content "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.deleteProductStockNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource /privatecustomers/{CustomerKey}/notifications: get: tags: - Notifications summary: Returns notifications endpoints description: This operation returns links to the stock and price notification endpoints of a user. operationId: getNotificationsBaseResource_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource.getNotifications() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource /privatecustomers/{CustomerKey}/notifications/price: get: tags: - Price Notifications summary: Returns price notifications description: This operation returns links to the price notifications of a customer. operationId: getProductNotifications_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getPriceNotificationDetails_1 parameters: CustomerProductPriceNotificationResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type ProductNotificationRO deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.getNotifications() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource post: tags: - Price Notifications summary: Creates price notification description: "This operation creates a new price notification.\n\nThe body must\ \ contain the `sku`, the `price`, and a `notificationMailAddress` to inform\ \ the user when the product price drops below this value." operationId: createPriceNotification_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/NewProductNotificationRO' responses: "201": description: Created "401": description: Unauthorized "409": description: Conflict - A price notification for this product already exists. "404": description: |- Not found - possible values for header error-key: - account.productnotification.product.not_found.error "400": description: |- Bad request - possible values for header error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error - account.productnotification.product.in_stock.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationsResource /privatecustomers/{CustomerKey}/notifications/price/{CustomerProductPriceNotificationResourceKey}: get: tags: - Price Notifications summary: Returns price notification details description: This operation returns details about a specific price notification. operationId: getPriceNotificationDetails_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductPriceNotificationResourceKey in: path description: Price notification ID required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' "401": description: Unauthorized "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.getProductPriceNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource put: tags: - Price Notifications summary: Updates price notification description: |- This operation updates an existing price notification. The body must contain a `price` and a `notificationMailAddress` to inform the user when the product price drops below this value. operationId: updatePriceNotification_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductPriceNotificationResourceKey in: path description: Price notification ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found "400": description: |- Bad request possible values for header error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.updateProductPriceNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource delete: tags: - Price Notifications summary: Deletes a price notification description: This operation deletes an existing price notification. operationId: deletePriceNotification_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductPriceNotificationResourceKey in: path description: Price notification ID required: true schema: type: string responses: "204": description: No content "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource.deleteProductPriceNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductPriceNotificationResource /privatecustomers/{CustomerKey}/notifications/stock: get: tags: - Stock Notifications summary: Returns stock notifications description: This operation returns links to the back in stock notifications of a customer. operationId: getStockNotifications_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionROLinkRO' links: itemInfo: operationId: getStockNotificationDetails_1 parameters: CustomerProductStockNotificationResourceKey: "$response.body#/elements/{$index}/itemId" description: Links to item of type ProductNotificationRO deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.getNotifications() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource post: tags: - Stock Notifications summary: Creates stock notification description: |- This operation creates a new back in stock notification. The body must contain the `sku` and a `notificationMailAddress` which is used to inform the user when the product is in stock again. operationId: createStockNotification_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/NewProductNotificationRO' responses: "201": description: Created "401": description: Unauthorized "409": description: Conflict- A stock notification for this product already exists. "404": description: |- Not found - possible values for header error-key: - account.productnotification.product.not_found.error "400": description: |- Bad request - possible values for header error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error - account.productnotification.product.in_stock.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource.createProductNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.NewProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationsResource /privatecustomers/{CustomerKey}/notifications/stock/{CustomerProductStockNotificationResourceKey}: get: tags: - Stock Notifications summary: Returns stock notification details description: This operation returns details of a specific back in stock notification. operationId: getStockNotificationDetails_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductStockNotificationResourceKey in: path description: Stock notification ID required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' "401": description: Unauthorized "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.getProductStockNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource put: tags: - Stock Notifications summary: Updates stock notification description: |- This operation updates an existing back in stock notification. The body must contain a `notificationMailAddress` which is used to inform the user when the product is in stock again. operationId: updateStockNotification_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductStockNotificationResourceKey in: path description: Stock notification ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProductNotificationRO' text/xml: schema: $ref: '#/components/schemas/ProductNotificationRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/AbstractResourceObject' text/xml: schema: $ref: '#/components/schemas/AbstractResourceObject' "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found "400": description: |- Bad request possible values for headere error-key: - account.productnotification.invalid_fields.error - account.productnotification.missing_fields.error deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public com.intershop.component.rest.capi.resourceobject.AbstractResourceObject com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.updateProductStockNotification(com.intershop.sellside.rest.common.capi.resourceobject.product.notification.ProductNotificationRO) x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource delete: tags: - Stock Notifications summary: Deletes a stock notification description: This operation deletes an existing back in stock notification. operationId: deleteStockNotification_1 parameters: - name: CustomerKey in: path description: Customer ID required: true schema: type: string - name: CustomerProductStockNotificationResourceKey in: path description: Stock notification ID required: true schema: type: string responses: "204": description: No content "401": description: Unauthorized "403": description: FORBIDDEN "404": description: Not found deprecated: true security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource.deleteProductStockNotification() x-origin-class: com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductStockNotificationResource components: schemas: AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true ResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/AbstractResourceObject' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - about - alternate - appendix - archives - author - bookmark - canonical - chapter - collection - contents - copyright - create-form - current - describedby - describes - disclosure - duplicate - edit - edit-form - edit-media - enclosure - first - glossary - help - hosts - hub - icon - index - item - last - latest-version - license - lrdd - monitor - monitor-group - next - next-archive - nofollow - noreferrer - payment - predecessor-version - prefetch - prev - preview - previous - prev-archive - privacy-policy - profile - related - replies - search - section - self - service - start - stylesheet - subsection - successor-version - tag - terms-of-service - type - up - version-history - via - working-copy - working-copy-of title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute ResourceCollectionROLinkRO: title: Link List type: object properties: pageable: type: string description: The pageable ID. total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' type: type: string description: "This is a constant: **ResourceCollection**" example: ResourceCollection xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of the returned element xml: attribute: true description: A list of links xml: name: ResourceCollection MoneyRO: title: Money type: object properties: type: type: string description: "This is a constant: **Money**" readOnly: true example: Money xml: attribute: true value: type: number description: The monetary value. example: 10.99 currencyMnemonic: type: string deprecated: true currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. example: USD description: Money combines a currency and a money amount. xml: name: Money NewProductNotificationRO: type: object properties: name: type: string description: The name of an element xml: attribute: true sku: type: string description: the sku of the product for this notification example: "10809311" price: $ref: '#/components/schemas/MoneyRO' notificationMailAddress: type: string description: the notification e-mail address for this notification example: pmiller@test.intershop.de xml: name: NewProductNotification ProductNotificationRO: type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' example: ProductNotification xml: attribute: true sku: type: string description: the sku of the product for this notification example: "10809311" price: $ref: '#/components/schemas/MoneyRO' notificationMailAddress: type: string description: the notification e-mail address for this notification example: pmiller@test.intershop.de xml: name: ProductNotification responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Złoty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: notification x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource,com.intershop.sellside.rest.common.capi.resource.customer.product.notification.CustomerProductNotificationsBaseResource"