Jump to

• Request
• Response

addProductNotification

post

/ccstore/v1/productnotify

Create a new product notification to send an email to a user when the specified product comes back in stock.

Request

Supported Media Types

• application/json

Body ()

Root Schema : generateProductNotify_request

Type: object

Show Source

• email: string
  Email address to send notification to
• expiryDate(optional): string
  Expiry date of notification
• locale: string
  Current locale of SF
• productId: string
  Id of the product to be notified on
• profileId(optional): string
  Profile Id of a logged in user
• siteId: string
  Id of the current site
• skuId: string
  SKU of the product

{
    "properties":{
        "expiryDate":{
            "description":"Expiry date of notification",
            "type":"string"
        },
        "productId":{
            "description":"Id of the product to be notified on",
            "type":"string"
        },
        "profileId":{
            "description":"Profile Id of a logged in user",
            "type":"string"
        },
        "siteId":{
            "description":"Id of the current site",
            "type":"string"
        },
        "locale":{
            "description":"Current locale of SF",
            "type":"string"
        },
        "skuId":{
            "description":"SKU of the product",
            "type":"string"
        },
        "email":{
            "description":"Email address to send notification to",
            "type":"string"
        }
    },
    "required":[
        "siteId",
        "productId",
        "skuId",
        "email",
        "locale"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

An object is returned that represents the product notification that has been added.

Body ()

Root Schema : generateProductNotify_response

Type: object

Show Source

• properties(optional): object properties
  JSON Object representing the notification added

{
    "properties":{
        "properties":{
            "description":"JSON Object representing the notification added",
            "type":"object"
        }
    }
}

Nested Schema : properties

Type: object

JSON Object representing the notification added

Example Response (application/json)

{
    "expiryDate":"2017-10-25T10:19:51.315Z",
    "dateCreated":"2017-09-25T10:19:51.315Z",
    "productId":"prod10001",
    "profileId":"profile1",
    "siteId":"siteUS",
    "links":[
        {
            "rel":"self",
            "href":"/ccstoreui/v1/productNotify/"
        }
    ],
    "locale":"en",
    "email":"",
    "skuId":"sku30005",
    "dateUpdated":null
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top