Loyalty Offer

Overview

The Loyalty Offers service allows you to create an offer in SAP Hybris Loyalty after coupon details, iBeacon details, and geofence details are provided. Once these coupons are created in the system, based on the certain attributes (iBeacon/geofence) information, notifications are sent to users with offer details. The following two types of offers are:

Push offer - Email is sent to a customer with an offer code when a particular condition is met.
Pull offer - Mobile app will request for valid offers for customers when they hit the specified geofence radius.

API Reference

/offers

This resourceType defines the GET, POST, DELETE methods and their responses for a collection resource.

/offers

get

Gets all Offer details. No coupon details are retrieved.

Accepted scopes:

'sap.loyoffer.view' - Required to view Offers

post

Creates a new Offer in the system. Need to pass offer and coupon details.

Details:

Offer Code should match with Coupon Code
Coupon gets created first and then offer gets created
Offer data is replicated into elastic search

Accepted scopes:

'sap.loyoffer.manage' - Required to create new Offers

Gets all Offer details. No coupon details are retrieved.

Accepted scopes:

'sap.loyoffer.view' - Required to view Offers

Request
Response

Headers

Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
```
pl
```
hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
```
en,pl,it
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Query Parameters

fields: (string)
Contains a comma separated list of field identifiers, by which the fields of the response entities should be filtered by. Empty or not initialized value result in a minimal set of entity fields returned. Non-existing or invalid fields will be ignored.
Example:
```
code,name,description
```
sort: (string)
The list of comma-separated values. Property identifiers used to sort the result. By default, the column values are sorted in ascending order. If preceded by a minus sign (-), the values are sorted in descending order.
Example:
```
name,-description
```
q: (string)
The simple query criteria based on available fields to limit returned results or a set of modified documents.
Example:
```
species:cat breed:"Norwegian Forest Cat" weight:(>3 AND <=5) age:(3,5,6) condition:exists
```
pageNumber: (integer - default: 1 - minimum: 1)
The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
Example:
```
1
```
pageSize: (integer - default: 16 - minimum: 1)
The number of documents being retrieved on the page.
Example:
```
16
```

HTTP status code 200

Resource successfully retrieved.

Headers

Link: required (string - repeat: true)
Link to the current page, the next page and the previous page. Marked accordingly with rel self, rel next and rel prev. The syntax must be conform to RFC-5988. The link to the current page (self) is required and must be provided always. The link to the next page (next) is optional. If not present, the next page is not available, as the current page is the last page of the result. The link to the previous page (prev) is optional. If not present, the previous page is not available, as the current page is the first page of the result.
Example:
```
<http://sample.com?pageNumber=2&pageSize=10>; rel="self", <http://sample.com?pageNumber=3&pageSize=10>; rel="next"
```

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Collection of Offer Management",
    "type": "array",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Offer Management",
        "type": "object",
        "properties": {
            "laasOffer": {
                "type": "object",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Offer Management",
                "properties": {
                    "offerId": {
                        "type": "string",
                        "maxLength": 32
                    },
                    "offerCode": {
                        "type": "string",
                        "maxLength": 24
                    },
                    "offerType": {
                        "enum": [
                            "NOTIFICATION",
                            "COUPON"
                        ]
                    },
                    "enableGeoMarketing": {
                        "type": "boolean"
                    },
                    "name": {
                        "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                    },
                    "description": {
                        "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                    },
                    "targetGroup": {
                        "type": "array",
                        "minItems": 1,
                        "uniqueItems": true,
                        "items": {
                            "type": "string"
                        }
                    },
                    "validFrom": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "validTo": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "publishStartDate": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "publishEndDate": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "emailTemplateId": {
                        "type": "string"
                    },
                    "couponTemplateId": {
                        "type": "string"
                    },
                    "createdBy": {
                        "type": "string",
                        "maxLength": 64
                    },
                    "updatedBy": {
                        "type": "string",
                        "maxLength": 64
                    },
                    "beacon": {
                        "type": "array",
                        "items": {
                            "$schema": "http://json-schema.org/draft-04/schema#",
                            "title": "Beacon Information",
                            "type": "object",
                            "properties": {
                                "id": {
                                    "type": "string"
                                },
                                "majorId": {
                                    "type": "integer",
                                    "minimum": 1,
                                    "maximum": 65535
                                },
                                "minorId": {
                                    "type": "integer",
                                    "minimum": 1,
                                    "maximum": 65535
                                }
                            }
                        }
                    },
                    "geoFence": {
                        "type": "array",
                        "uniqueItems": true,
                        "items": {
                            "type": "string"
                        }
                    },
                    "offerStatus": {
                        "enum": [
                            "ACTIVE",
                            "INACTIVE"
                        ]
                    },
                    "externalId": {
                        "type": "string",
                        "maxLength": 24
                    },
                    "originId": {
                        "type": "string",
                        "maxLength": 20
                    }
                },
                "required": [
                    "offerId",
                    "offerType",
                    "validFrom",
                    "validTo",
                    "name"
                ]
            },
            "coupon": {
                "type": "object",
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Coupon API",
                "description": "Coupons describe voucher alike commerce capabilities.",
                "properties": {
                    "code": {
                        "type": "string",
                        "description": "e.g.: WINTER-SALE, 10OFF (read-only)"
                    },
                    "name": {
                        "type": "string",
                        "description": "Localized name"
                    },
                    "description": {
                        "type": "string",
                        "description": "Localized coupon description"
                    },
                    "discountType": {
                        "enum": [
                            "PERCENT",
                            "ABSOLUTE"
                        ],
                        "description": "'PERCENT' for relative values or 'ABSOLUTE' for float values, referring to a specific currency."
                    },
                    "discountPercentage": {
                        "type": "number",
                        "description": "A discount percentage within the range [0.00, 100.00]. Required if type is 'PERCENT'.",
                        "minimum": 0,
                        "maximum": 100
                    },
                    "discountAbsolute": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "title": "Money Amount",
                        "description": "Required if type is 'ABSOLUTE'",
                        "properties": {
                            "amount": {
                                "type": "number",
                                "default": 0,
                                "minimum": 0,
                                "description": "The total amount in the specified currency."
                            },
                            "currency": {
                                "type": "string",
                                "default": "USD",
                                "pattern": "^[A-Z]{3}$",
                                "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                            }
                        }
                    },
                    "allowAnonymous": {
                        "type": "boolean",
                        "description": "Can the coupon be redeemed by anonymous user",
                        "default": false
                    },
                    "maxRedemptions": {
                        "type": "number",
                        "description": "Maximum number of redemptions; -1 designates 'unlimited' (seller-only)",
                        "default": -1
                    },
                    "maxRedemptionsPerCustomer": {
                        "type": "number",
                        "description": "Maximum number of redemptions per customer; -1 designates 'unlimited'. Cannot be specified for coupons which can be redeemed by anonymous users.",
                        "default": -1
                    },
                    "restrictions": {
                        "validFor": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            },
                            "description": "A list of customer identifiers, which can redeem the coupon. Cannot be specified for coupons which can be redeemed by anonymous users.",
                            "default": []
                        },
                        "validFrom": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                        },
                        "validUntil": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                        },
                        "minOrderValue": {
                            "$schema": "http://json-schema.org/draft-04/schema#",
                            "type": "object",
                            "title": "Money Amount",
                            "description": "Minimum order value which entitles the customer to redeem the coupon.",
                            "properties": {
                                "amount": {
                                    "type": "number",
                                    "default": 0,
                                    "minimum": 0,
                                    "description": "The total amount in the specified currency."
                                },
                                "currency": {
                                    "type": "string",
                                    "default": "USD",
                                    "pattern": "^[a-z]{3}$",
                                    "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                                }
                            }
                        }
                    },
                    "issuedTo": {
                        "type": "string",
                        "description": "The Id of the customer who originally received the coupon (seller-only)."
                    },
                    "redemptionCount": {
                        "type": "number",
                        "description": "The number of times a specific coupon has been redeemed. Read-only, set through server. (seller-only)"
                    },
                    "status": {
                        "enum": [
                            "INACTIVE",
                            "VALID",
                            "EXPIRED",
                            "USED"
                        ],
                        "description": "Current status of the coupon (read-only). 'INACTIVE': the coupon is only valid in the future; 'VALID': can be used; 'EXPIRED': the coupon validity period has expired; 'USED': the maximum number of redemptions for the coupon has been reached."
                    },
                    "links": {
                        "description": "Hypermedia reference to coupon actions (read-only, customer-only)",
                        "type": "array",
                        "items": {
                            "$schema": "http://json-schema.org/draft-04/schema#",
                            "type": "object",
                            "description": "Hypermedia reference to a resource",
                            "properties": {
                                "rel": {
                                    "type": "string",
                                    "description": "Link relation type"
                                },
                                "title": {
                                    "type": "string",
                                    "description": "Link title"
                                },
                                "href": {
                                    "type": "string",
                                    "description": "Target URI of the link"
                                },
                                "type": {
                                    "type": "string",
                                    "description": "A content type of the referenced resource"
                                }
                            },
                            "required": [
                                "rel",
                                "title",
                                "href",
                                "type"
                            ]
                        }
                    },
                    "deleted": {
                        "description": "Flag to mark a coupon as deleted (a.k.a. Soft delete). It is a read-only and seller-only attribute",
                        "type": "boolean"
                    }
                },
                "required": [
                    "name",
                    "discountType",
                    "status"
                ]
            }
        }
    }
}

Example:

[
    {
        "laasOffer": {
            "offerId": "f01c2b4295ef4d9284d2e0e8566da8b0",
            "offerType": "COUPON",
            "offerCode": "JX1AQ8X7",
            "name": {
                "en": "JUnit Offer",
                "fr": "JUnit Offer Fr"
            },
            "description": {
                "en": "Junit 19% discount offer",
                "fr": "Junit 19% discount offer fr"
            },
            "validFrom": "2016-04-01T00:00:00.000Z",
            "validTo": "2016-12-31T00:00:00.000Z",
            "emailTemplateId": "GenericOfferEmail",
            "couponTemplateId": "2222",
            "targetGroup": [
                "Silver"
            ],
            "geoFence": [
                "bdc44400241e44fd8cf0f8f867aff5bf",
                "c03c1052320d41e1aad653a66c8baf87",
                "e7ac5f85ce1548e3a3b25cf7210506e6",
                "38a33775fd224c4e8e14bc64b725cbf2"
            ],
            "enableGeoMarketing": true,
            "beacon": [
                {
                    "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                    "majorId": 100,
                    "minorId": 800
                },
                {
                    "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                    "majorId": 100,
                    "minorId": 8001
                }
            ]
        },
        "coupon": {
            "code": "JX1AQ8X7",
            "name": "JX1AQ8X7",
            "discountType": "PERCENT",
            "discountPercentage": "19",
            "allowAnonymous": false,
            "restrictions": {
                "validFrom": "2016-03-29T14:55:27.763Z",
                "validUntil": "2016-12-31T14:55:27.764Z"
            },
            "status": "VALID"
        }
    },
    {
        "laasOffer": {
            "offerId": "f01c2b4295ef4d9284d2e0e8566da8b0",
            "offerType": "COUPON",
            "offerCode": "JX1AQ8X7",
            "name": {
                "en": "JUnit Offer",
                "fr": "JUnit Offer Fr"
            },
            "description": {
                "en": "Junit 20% discount offer",
                "fr": "Junit 20% discount offer fr"
            },
            "validFrom": "2016-04-01T00:00:00.000Z",
            "validTo": "2016-12-31T00:00:00.000Z",
            "emailTemplateId": "GenericOfferEmail",
            "couponTemplateId": "2222",
            "targetGroup": [
                "Silver"
            ],
            "geoFence": [
                "bdc44400241e44fd8cf0f8f867aff5bf",
                "c03c1052320d41e1aad653a66c8baf87",
                "e7ac5f85ce1548e3a3b25cf7210506e6",
                "38a33775fd224c4e8e14bc64b725cbf2"
            ],
            "enableGeoMarketing": true,
            "beacon": [
                {
                    "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                    "majorId": 100,
                    "minorId": 800
                },
                {
                    "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                    "majorId": 100,
                    "minorId": 8001
                }
            ]
        },
        "coupon": {
            "code": "JX1AQ8X7",
            "name": "JX1AQ8X7",
            "discountType": "PERCENT",
            "discountPercentage": "20",
            "allowAnonymous": false,
            "restrictions": {
                "validFrom": "2016-03-29T14:55:27.763Z",
                "validUntil": "2016-12-31T14:55:27.764Z"
            },
            "status": "VALID"
        }
    }
]

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "There are validation problems, see details section for more information",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "validation_violation",
    "details": [
        {
            "field": "Accept-Language",
            "message": "not a language",
            "type": "invalid_header"
        }
    ]
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

Creates a new Offer in the system. Need to pass offer and coupon details.

Details:

Offer Code should match with Coupon Code
Coupon gets created first and then offer gets created
Offer data is replicated into elastic search

Accepted scopes:

'sap.loyoffer.manage' - Required to create new Offers

Request
Response

Headers

Content-Language: (string)
The locale identifier of the language of the updated attribute.
Example:
```
pl
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Offer Management",
    "type": "object",
    "properties": {
        "laasOffer": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Offer Management",
            "properties": {
                "offerId": {
                    "type": "string",
                    "maxLength": 32
                },
                "offerCode": {
                    "type": "string",
                    "maxLength": 24
                },
                "offerType": {
                    "enum": [
                        "NOTIFICATION",
                        "COUPON"
                    ]
                },
                "enableGeoMarketing": {
                    "type": "boolean"
                },
                "name": {
                    "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                },
                "description": {
                    "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                },
                "targetGroup": {
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                },
                "validFrom": {
                    "type": "string",
                    "format": "date-time"
                },
                "validTo": {
                    "type": "string",
                    "format": "date-time"
                },
                "publishStartDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "publishEndDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "emailTemplateId": {
                    "type": "string"
                },
                "couponTemplateId": {
                    "type": "string"
                },
                "createdBy": {
                    "type": "string",
                    "maxLength": 64
                },
                "updatedBy": {
                    "type": "string",
                    "maxLength": 64
                },
                "beacon": {
                    "type": "array",
                    "items": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "title": "Beacon Information",
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "majorId": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                            },
                            "minorId": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                            }
                        }
                    }
                },
                "geoFence": {
                    "type": "array",
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                },
                "offerStatus": {
                    "enum": [
                        "ACTIVE",
                        "INACTIVE"
                    ]
                },
                "externalId": {
                    "type": "string",
                    "maxLength": 24
                },
                "originId": {
                    "type": "string",
                    "maxLength": 20
                }
            },
            "required": [
                "offerId",
                "offerType",
                "validFrom",
                "validTo",
                "name"
            ]
        },
        "coupon": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Coupon API",
            "description": "Coupons describe voucher alike commerce capabilities.",
            "properties": {
                "code": {
                    "type": "string",
                    "description": "e.g.: WINTER-SALE, 10OFF (read-only)"
                },
                "name": {
                    "type": "string",
                    "description": "Localized name"
                },
                "description": {
                    "type": "string",
                    "description": "Localized coupon description"
                },
                "discountType": {
                    "enum": [
                        "PERCENT",
                        "ABSOLUTE"
                    ],
                    "description": "'PERCENT' for relative values or 'ABSOLUTE' for float values, referring to a specific currency."
                },
                "discountPercentage": {
                    "type": "number",
                    "description": "A discount percentage within the range [0.00, 100.00]. Required if type is 'PERCENT'.",
                    "minimum": 0,
                    "maximum": 100
                },
                "discountAbsolute": {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "type": "object",
                    "title": "Money Amount",
                    "description": "Required if type is 'ABSOLUTE'",
                    "properties": {
                        "amount": {
                            "type": "number",
                            "default": 0,
                            "minimum": 0,
                            "description": "The total amount in the specified currency."
                        },
                        "currency": {
                            "type": "string",
                            "default": "USD",
                            "pattern": "^[A-Z]{3}$",
                            "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                        }
                    }
                },
                "allowAnonymous": {
                    "type": "boolean",
                    "description": "Can the coupon be redeemed by anonymous user",
                    "default": false
                },
                "maxRedemptions": {
                    "type": "number",
                    "description": "Maximum number of redemptions; -1 designates 'unlimited' (seller-only)",
                    "default": -1
                },
                "maxRedemptionsPerCustomer": {
                    "type": "number",
                    "description": "Maximum number of redemptions per customer; -1 designates 'unlimited'. Cannot be specified for coupons which can be redeemed by anonymous users.",
                    "default": -1
                },
                "restrictions": {
                    "validFor": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "description": "A list of customer identifiers, which can redeem the coupon. Cannot be specified for coupons which can be redeemed by anonymous users.",
                        "default": []
                    },
                    "validFrom": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                    },
                    "validUntil": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                    },
                    "minOrderValue": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "title": "Money Amount",
                        "description": "Minimum order value which entitles the customer to redeem the coupon.",
                        "properties": {
                            "amount": {
                                "type": "number",
                                "default": 0,
                                "minimum": 0,
                                "description": "The total amount in the specified currency."
                            },
                            "currency": {
                                "type": "string",
                                "default": "USD",
                                "pattern": "^[a-z]{3}$",
                                "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                            }
                        }
                    }
                },
                "issuedTo": {
                    "type": "string",
                    "description": "The Id of the customer who originally received the coupon (seller-only)."
                },
                "redemptionCount": {
                    "type": "number",
                    "description": "The number of times a specific coupon has been redeemed. Read-only, set through server. (seller-only)"
                },
                "status": {
                    "enum": [
                        "INACTIVE",
                        "VALID",
                        "EXPIRED",
                        "USED"
                    ],
                    "description": "Current status of the coupon (read-only). 'INACTIVE': the coupon is only valid in the future; 'VALID': can be used; 'EXPIRED': the coupon validity period has expired; 'USED': the maximum number of redemptions for the coupon has been reached."
                },
                "links": {
                    "description": "Hypermedia reference to coupon actions (read-only, customer-only)",
                    "type": "array",
                    "items": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "description": "Hypermedia reference to a resource",
                        "properties": {
                            "rel": {
                                "type": "string",
                                "description": "Link relation type"
                            },
                            "title": {
                                "type": "string",
                                "description": "Link title"
                            },
                            "href": {
                                "type": "string",
                                "description": "Target URI of the link"
                            },
                            "type": {
                                "type": "string",
                                "description": "A content type of the referenced resource"
                            }
                        },
                        "required": [
                            "rel",
                            "title",
                            "href",
                            "type"
                        ]
                    }
                },
                "deleted": {
                    "description": "Flag to mark a coupon as deleted (a.k.a. Soft delete). It is a read-only and seller-only attribute",
                    "type": "boolean"
                }
            },
            "required": [
                "name",
                "discountType",
                "status"
            ]
        }
    }
}

Example:

{
    "laasOffer": {
        "offerId": "f01c2b4295ef4d9284d2e0e8566da8b0",
        "offerType": "COUPON",
        "offerCode": "JX1AQ8X7",
        "name": {
            "en": "JUnit Offer",
            "fr": "JUnit Offer Fr"
        },
        "description": {
            "en": "Junit 18% discount offer",
            "fr": "Junit 18% discount offer fr"
        },
        "validFrom": "2016-04-01T00:00:00.000Z",
        "validTo": "2016-12-31T00:00:00.000Z",
        "emailTemplateId": "GenericOfferEmail",
        "couponTemplateId": "2222",
        "targetGroup": [
            "Silver"
        ],
        "geoFence": [
            "bdc44400241e44fd8cf0f8f867aff5bf",
            "c03c1052320d41e1aad653a66c8baf87",
            "e7ac5f85ce1548e3a3b25cf7210506e6",
            "38a33775fd224c4e8e14bc64b725cbf2"
        ],
        "enableGeoMarketing": true,
        "beacon": [
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 800
            },
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 8001
            }
        ]
    },
    "coupon": {
        "code": "JX1AQ8X7",
        "name": "JX1AQ8X7",
        "discountType": "PERCENT",
        "discountPercentage": "18",
        "allowAnonymous": false,
        "restrictions": {
            "validFrom": "2016-03-29T14:55:27.763Z",
            "validUntil": "2016-12-31T14:55:27.764Z"
        },
        "status": "VALID"
    }
}

HTTP status code 201

The collection resource has been successfully created.

Headers

Location: required (string)
The Location of the new resource which was created by the request. The value consists of a single absolute URI.
Example:
```
http://www.hybris.com/items/myItem
```

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "The request payload has incorrect syntax.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "bad_payload_syntax"
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 409,
    "message": "The requested resource could not be created due to server-side validation.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "conflict_resource"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

/offers/aggr

get

Gets Average, Sum and Count for Loyalty Offers

Accepted scopes:

'sap.loyoffer.view' - Required to view aggregation

Gets Average, Sum and Count for Loyalty Offers

Accepted scopes:

'sap.loyoffer.view' - Required to view aggregation

Request
Response

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Query Parameters

totalCount: (boolean)
This parameter requests to return the total number of object in the collection fulfilling the criteria together with the response. This number will be returned in the 'hybris-count' header.
Example:
```
true
```
q: (string)
The simple query criteria based on available fields to limit returned results or a set of modified documents.
Example:
```
species:cat breed:"Norwegian Forest Cat" weight:(>3 AND <=5) age:(3,5,6) condition:exists
```
sum: (string)
List of comma separated attributes for Sum
Example:
```
attribute1, attribute2
```
avg: (string)
List of comma separated attributes for Sum
Example:
```
attribute1, attribute2
```

HTTP status code 200

Headers

hybris-count: (integer)
The total number of objects that fulfil the criteria.
Example:
```
1000
```

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "There are validation problems, see details section for more information",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "validation_violation",
    "details": [
        {
            "field": "totalCount",
            "message": "must be a boolean",
            "type": "invalid_query_parameter"
        }
    ]
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

/offers/search

post

Gets Offers using Elastic Search for enhanced search

Accepted scopes:

'sap.loyoffer.manage' - Required to fetch data from Elastic Search

Gets Offers using Elastic Search for enhanced search

Accepted scopes:

'sap.loyoffer.manage' - Required to fetch data from Elastic Search

Request
Response

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Body

Type: application/json

HTTP status code 200

Body

Type: application/json

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

/offers/laasOffer/{laasOfferId}

This resource type defines the GET, PUT, DELETE methods and their responses for a single element resource.

get

Gets an Offer details along with corresponding coupon data

Accepted scopes:

'sap.loyoffer.view' - Required to view Offer details

put

Updates a single laasOffer entity.

delete

Deletes a single laasOffer entity.

Gets an Offer details along with corresponding coupon data

Accepted scopes:

'sap.loyoffer.view' - Required to view Offer details

Request
Response

URI Parameters

laasOfferId: required (string)

Headers

Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
```
pl
```
hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
```
en,pl,it
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 200

laasOffer successfully retrieved.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Offer Management",
    "type": "object",
    "properties": {
        "offerId": {
            "type": "string",
            "maxLength": 32
        },
        "offerCode": {
            "type": "string",
            "maxLength": 24
        },
        "offerType": {
            "enum": [
                "NOTIFICATION",
                "COUPON"
            ]
        },
        "enableGeoMarketing": {
            "type": "boolean"
        },
        "name": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
        },
        "description": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
        },
        "targetGroup": {
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
                "type": "string"
            }
        },
        "validFrom": {
            "type": "string",
            "format": "date-time"
        },
        "validTo": {
            "type": "string",
            "format": "date-time"
        },
        "publishStartDate": {
            "type": "string",
            "format": "date-time"
        },
        "publishEndDate": {
            "type": "string",
            "format": "date-time"
        },
        "emailTemplateId": {
            "type": "string"
        },
        "couponTemplateId": {
            "type": "string"
        },
        "createdBy": {
            "type": "string",
            "maxLength": 64
        },
        "updatedBy": {
            "type": "string",
            "maxLength": 64
        },
        "beacon": {
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Beacon Information",
                "type": "object",
                "properties": {
                    "id": {
                        "type": "string"
                    },
                    "majorId": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 65535
                    },
                    "minorId": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 65535
                    }
                }
            }
        },
        "geoFence": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string"
            }
        },
        "offerStatus": {
            "enum": [
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "externalId": {
            "type": "string",
            "maxLength": 24
        },
        "originId": {
            "type": "string",
            "maxLength": 20
        }
    },
    "required": [
        "offerId",
        "offerType",
        "validFrom",
        "validTo",
        "name"
    ]
}

Example:

{
    "laasOffer": {
        "offerId": "f01c2b4295ef4d9284d2e0e8566da8b0",
        "offerType": "COUPON",
        "offerCode": "JX1AQ8X7",
        "name": {
            "en": "JUnit Offer",
            "fr": "JUnit Offer Fr"
        },
        "description": {
            "en": "Junit 18% discount offer",
            "fr": "Junit 18% discount offer fr"
        },
        "validFrom": "2016-04-01T00:00:00.000Z",
        "validTo": "2016-12-31T00:00:00.000Z",
        "emailTemplateId": "GenericOfferEmail",
        "couponTemplateId": "2222",
        "targetGroup": [
            "Silver"
        ],
        "geoFence": [
            "bdc44400241e44fd8cf0f8f867aff5bf",
            "c03c1052320d41e1aad653a66c8baf87",
            "e7ac5f85ce1548e3a3b25cf7210506e6",
            "38a33775fd224c4e8e14bc64b725cbf2"
        ],
        "enableGeoMarketing": true,
        "beacon": [
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 800
            },
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 8001
            }
        ]
    },
    "coupon": {
        "code": "JX1AQ8X7",
        "name": "JX1AQ8X7",
        "discountType": "PERCENT",
        "discountPercentage": "18",
        "allowAnonymous": false,
        "restrictions": {
            "validFrom": "2016-03-29T14:55:27.763Z",
            "validUntil": "2016-12-31T14:55:27.764Z"
        },
        "status": "VALID"
    }
}

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "There are validation problems, see details section for more information",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "validation_violation",
    "details": [
        {
            "field": "Accept-Language",
            "message": "not a language",
            "type": "invalid_header"
        }
    ]
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 404

The requested resource does not exist.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 404,
    "message": "The requested URI does not map to a single element resource.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "element_resource_non_existing"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

Updates a single laasOffer entity.

Request
Response

URI Parameters

laasOfferId: required (string)

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Offer Management",
    "type": "object",
    "properties": {
        "offerId": {
            "type": "string",
            "maxLength": 32
        },
        "offerCode": {
            "type": "string",
            "maxLength": 24
        },
        "offerType": {
            "enum": [
                "NOTIFICATION",
                "COUPON"
            ]
        },
        "enableGeoMarketing": {
            "type": "boolean"
        },
        "name": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
        },
        "description": {
            "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
        },
        "targetGroup": {
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {
                "type": "string"
            }
        },
        "validFrom": {
            "type": "string",
            "format": "date-time"
        },
        "validTo": {
            "type": "string",
            "format": "date-time"
        },
        "publishStartDate": {
            "type": "string",
            "format": "date-time"
        },
        "publishEndDate": {
            "type": "string",
            "format": "date-time"
        },
        "emailTemplateId": {
            "type": "string"
        },
        "couponTemplateId": {
            "type": "string"
        },
        "createdBy": {
            "type": "string",
            "maxLength": 64
        },
        "updatedBy": {
            "type": "string",
            "maxLength": 64
        },
        "beacon": {
            "type": "array",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "Beacon Information",
                "type": "object",
                "properties": {
                    "id": {
                        "type": "string"
                    },
                    "majorId": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 65535
                    },
                    "minorId": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 65535
                    }
                }
            }
        },
        "geoFence": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "type": "string"
            }
        },
        "offerStatus": {
            "enum": [
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "externalId": {
            "type": "string",
            "maxLength": 24
        },
        "originId": {
            "type": "string",
            "maxLength": 20
        }
    },
    "required": [
        "offerId",
        "offerType",
        "validFrom",
        "validTo",
        "name"
    ]
}

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "The request payload has incorrect syntax.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "bad_payload_syntax"
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 404

The requested resource does not exist.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 404,
    "message": "The requested URI does not map to a single element resource.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "element_resource_non_existing"
}

HTTP status code 409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 409,
    "message": "The requested resource could not be updated due to server-side validation.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "conflict_resource"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

Deletes a single laasOffer entity.

Request
Response

URI Parameters

laasOfferId: required (string)

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

The resource has been successfully deleted.

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 404

The requested resource does not exist.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 404,
    "message": "The requested URI does not map to a single element resource.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "element_resource_non_existing"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

/offers/{offerId}

This resource type defines the GET, PUT, DELETE methods and their responses for a single element resource.

get

Gets an Offer details. No coupon details are retrieved.

Accepted scopes:

'sap.loyoffer.view' - Required to view Offer details

put

Updates an Offer details.

Accepted scopes:

'sap.loyoffer.manage' - Required to update Offers

delete

Deletes an Offer

Accepted scopes:

'sap.loyoffer.delete' - Required to soft delete Offers

Gets an Offer details. No coupon details are retrieved.

Accepted scopes:

'sap.loyoffer.view' - Required to view Offer details

Request
Response

URI Parameters

offerId: required (string)

Headers

Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
```
pl
```
hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
```
en,pl,it
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 200

offer successfully retrieved.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Offer Management",
    "type": "object",
    "properties": {
        "laasOffer": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Offer Management",
            "properties": {
                "offerId": {
                    "type": "string",
                    "maxLength": 32
                },
                "offerCode": {
                    "type": "string",
                    "maxLength": 24
                },
                "offerType": {
                    "enum": [
                        "NOTIFICATION",
                        "COUPON"
                    ]
                },
                "enableGeoMarketing": {
                    "type": "boolean"
                },
                "name": {
                    "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                },
                "description": {
                    "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                },
                "targetGroup": {
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                },
                "validFrom": {
                    "type": "string",
                    "format": "date-time"
                },
                "validTo": {
                    "type": "string",
                    "format": "date-time"
                },
                "publishStartDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "publishEndDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "emailTemplateId": {
                    "type": "string"
                },
                "couponTemplateId": {
                    "type": "string"
                },
                "createdBy": {
                    "type": "string",
                    "maxLength": 64
                },
                "updatedBy": {
                    "type": "string",
                    "maxLength": 64
                },
                "beacon": {
                    "type": "array",
                    "items": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "title": "Beacon Information",
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "majorId": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                            },
                            "minorId": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                            }
                        }
                    }
                },
                "geoFence": {
                    "type": "array",
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                },
                "offerStatus": {
                    "enum": [
                        "ACTIVE",
                        "INACTIVE"
                    ]
                },
                "externalId": {
                    "type": "string",
                    "maxLength": 24
                },
                "originId": {
                    "type": "string",
                    "maxLength": 20
                }
            },
            "required": [
                "offerId",
                "offerType",
                "validFrom",
                "validTo",
                "name"
            ]
        },
        "coupon": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Coupon API",
            "description": "Coupons describe voucher alike commerce capabilities.",
            "properties": {
                "code": {
                    "type": "string",
                    "description": "e.g.: WINTER-SALE, 10OFF (read-only)"
                },
                "name": {
                    "type": "string",
                    "description": "Localized name"
                },
                "description": {
                    "type": "string",
                    "description": "Localized coupon description"
                },
                "discountType": {
                    "enum": [
                        "PERCENT",
                        "ABSOLUTE"
                    ],
                    "description": "'PERCENT' for relative values or 'ABSOLUTE' for float values, referring to a specific currency."
                },
                "discountPercentage": {
                    "type": "number",
                    "description": "A discount percentage within the range [0.00, 100.00]. Required if type is 'PERCENT'.",
                    "minimum": 0,
                    "maximum": 100
                },
                "discountAbsolute": {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "type": "object",
                    "title": "Money Amount",
                    "description": "Required if type is 'ABSOLUTE'",
                    "properties": {
                        "amount": {
                            "type": "number",
                            "default": 0,
                            "minimum": 0,
                            "description": "The total amount in the specified currency."
                        },
                        "currency": {
                            "type": "string",
                            "default": "USD",
                            "pattern": "^[A-Z]{3}$",
                            "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                        }
                    }
                },
                "allowAnonymous": {
                    "type": "boolean",
                    "description": "Can the coupon be redeemed by anonymous user",
                    "default": false
                },
                "maxRedemptions": {
                    "type": "number",
                    "description": "Maximum number of redemptions; -1 designates 'unlimited' (seller-only)",
                    "default": -1
                },
                "maxRedemptionsPerCustomer": {
                    "type": "number",
                    "description": "Maximum number of redemptions per customer; -1 designates 'unlimited'. Cannot be specified for coupons which can be redeemed by anonymous users.",
                    "default": -1
                },
                "restrictions": {
                    "validFor": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "description": "A list of customer identifiers, which can redeem the coupon. Cannot be specified for coupons which can be redeemed by anonymous users.",
                        "default": []
                    },
                    "validFrom": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                    },
                    "validUntil": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                    },
                    "minOrderValue": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "title": "Money Amount",
                        "description": "Minimum order value which entitles the customer to redeem the coupon.",
                        "properties": {
                            "amount": {
                                "type": "number",
                                "default": 0,
                                "minimum": 0,
                                "description": "The total amount in the specified currency."
                            },
                            "currency": {
                                "type": "string",
                                "default": "USD",
                                "pattern": "^[a-z]{3}$",
                                "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                            }
                        }
                    }
                },
                "issuedTo": {
                    "type": "string",
                    "description": "The Id of the customer who originally received the coupon (seller-only)."
                },
                "redemptionCount": {
                    "type": "number",
                    "description": "The number of times a specific coupon has been redeemed. Read-only, set through server. (seller-only)"
                },
                "status": {
                    "enum": [
                        "INACTIVE",
                        "VALID",
                        "EXPIRED",
                        "USED"
                    ],
                    "description": "Current status of the coupon (read-only). 'INACTIVE': the coupon is only valid in the future; 'VALID': can be used; 'EXPIRED': the coupon validity period has expired; 'USED': the maximum number of redemptions for the coupon has been reached."
                },
                "links": {
                    "description": "Hypermedia reference to coupon actions (read-only, customer-only)",
                    "type": "array",
                    "items": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "description": "Hypermedia reference to a resource",
                        "properties": {
                            "rel": {
                                "type": "string",
                                "description": "Link relation type"
                            },
                            "title": {
                                "type": "string",
                                "description": "Link title"
                            },
                            "href": {
                                "type": "string",
                                "description": "Target URI of the link"
                            },
                            "type": {
                                "type": "string",
                                "description": "A content type of the referenced resource"
                            }
                        },
                        "required": [
                            "rel",
                            "title",
                            "href",
                            "type"
                        ]
                    }
                },
                "deleted": {
                    "description": "Flag to mark a coupon as deleted (a.k.a. Soft delete). It is a read-only and seller-only attribute",
                    "type": "boolean"
                }
            },
            "required": [
                "name",
                "discountType",
                "status"
            ]
        }
    }
}

Example:

{
    "laasOffer": {
        "offerId": "f01c2b4295ef4d9284d2e0e8566da8b0",
        "offerType": "COUPON",
        "offerCode": "JX1AQ8X7",
        "name": {
            "en": "JUnit Offer",
            "fr": "JUnit Offer Fr"
        },
        "description": {
            "en": "Junit 18% discount offer",
            "fr": "Junit 18% discount offer fr"
        },
        "validFrom": "2016-04-01T00:00:00.000Z",
        "validTo": "2016-12-31T00:00:00.000Z",
        "emailTemplateId": "GenericOfferEmail",
        "couponTemplateId": "2222",
        "targetGroup": [
            "Silver"
        ],
        "geoFence": [
            "bdc44400241e44fd8cf0f8f867aff5bf",
            "c03c1052320d41e1aad653a66c8baf87",
            "e7ac5f85ce1548e3a3b25cf7210506e6",
            "38a33775fd224c4e8e14bc64b725cbf2"
        ],
        "enableGeoMarketing": true,
        "beacon": [
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 800
            },
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 8001
            }
        ]
    },
    "coupon": {
        "code": "JX1AQ8X7",
        "name": "JX1AQ8X7",
        "discountType": "PERCENT",
        "discountPercentage": "18",
        "allowAnonymous": false,
        "restrictions": {
            "validFrom": "2016-03-29T14:55:27.763Z",
            "validUntil": "2016-12-31T14:55:27.764Z"
        },
        "status": "VALID"
    }
}

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "There are validation problems, see details section for more information",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "validation_violation",
    "details": [
        {
            "field": "Accept-Language",
            "message": "not a language",
            "type": "invalid_header"
        }
    ]
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 404

The requested resource does not exist.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 404,
    "message": "The requested URI does not map to a single element resource.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "element_resource_non_existing"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

Updates an Offer details.

Accepted scopes:

'sap.loyoffer.manage' - Required to update Offers

Request
Response

URI Parameters

offerId: required (string)

Headers

Content-Language: (string)
The locale identifier of the language of the updated attribute.
Example:
```
pl
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Query Parameters

patch: (boolean)
If true, a partial update will be supported, otherwise the full object replacement will be performed.
Example:
```
true
```

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Offer Management",
    "type": "object",
    "properties": {
        "laasOffer": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Offer Management",
            "properties": {
                "offerId": {
                    "type": "string",
                    "maxLength": 32
                },
                "offerCode": {
                    "type": "string",
                    "maxLength": 24
                },
                "offerType": {
                    "enum": [
                        "NOTIFICATION",
                        "COUPON"
                    ]
                },
                "enableGeoMarketing": {
                    "type": "boolean"
                },
                "name": {
                    "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                },
                "description": {
                    "$ref": "https://api.yaas.io/patterns/v1/schema-localized.json"
                },
                "targetGroup": {
                    "type": "array",
                    "minItems": 1,
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                },
                "validFrom": {
                    "type": "string",
                    "format": "date-time"
                },
                "validTo": {
                    "type": "string",
                    "format": "date-time"
                },
                "publishStartDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "publishEndDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "emailTemplateId": {
                    "type": "string"
                },
                "couponTemplateId": {
                    "type": "string"
                },
                "createdBy": {
                    "type": "string",
                    "maxLength": 64
                },
                "updatedBy": {
                    "type": "string",
                    "maxLength": 64
                },
                "beacon": {
                    "type": "array",
                    "items": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "title": "Beacon Information",
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "majorId": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                            },
                            "minorId": {
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 65535
                            }
                        }
                    }
                },
                "geoFence": {
                    "type": "array",
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                },
                "offerStatus": {
                    "enum": [
                        "ACTIVE",
                        "INACTIVE"
                    ]
                },
                "externalId": {
                    "type": "string",
                    "maxLength": 24
                },
                "originId": {
                    "type": "string",
                    "maxLength": 20
                }
            },
            "required": [
                "offerId",
                "offerType",
                "validFrom",
                "validTo",
                "name"
            ]
        },
        "coupon": {
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "title": "Coupon API",
            "description": "Coupons describe voucher alike commerce capabilities.",
            "properties": {
                "code": {
                    "type": "string",
                    "description": "e.g.: WINTER-SALE, 10OFF (read-only)"
                },
                "name": {
                    "type": "string",
                    "description": "Localized name"
                },
                "description": {
                    "type": "string",
                    "description": "Localized coupon description"
                },
                "discountType": {
                    "enum": [
                        "PERCENT",
                        "ABSOLUTE"
                    ],
                    "description": "'PERCENT' for relative values or 'ABSOLUTE' for float values, referring to a specific currency."
                },
                "discountPercentage": {
                    "type": "number",
                    "description": "A discount percentage within the range [0.00, 100.00]. Required if type is 'PERCENT'.",
                    "minimum": 0,
                    "maximum": 100
                },
                "discountAbsolute": {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "type": "object",
                    "title": "Money Amount",
                    "description": "Required if type is 'ABSOLUTE'",
                    "properties": {
                        "amount": {
                            "type": "number",
                            "default": 0,
                            "minimum": 0,
                            "description": "The total amount in the specified currency."
                        },
                        "currency": {
                            "type": "string",
                            "default": "USD",
                            "pattern": "^[A-Z]{3}$",
                            "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                        }
                    }
                },
                "allowAnonymous": {
                    "type": "boolean",
                    "description": "Can the coupon be redeemed by anonymous user",
                    "default": false
                },
                "maxRedemptions": {
                    "type": "number",
                    "description": "Maximum number of redemptions; -1 designates 'unlimited' (seller-only)",
                    "default": -1
                },
                "maxRedemptionsPerCustomer": {
                    "type": "number",
                    "description": "Maximum number of redemptions per customer; -1 designates 'unlimited'. Cannot be specified for coupons which can be redeemed by anonymous users.",
                    "default": -1
                },
                "restrictions": {
                    "validFor": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "description": "A list of customer identifiers, which can redeem the coupon. Cannot be specified for coupons which can be redeemed by anonymous users.",
                        "default": []
                    },
                    "validFrom": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                    },
                    "validUntil": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Must be provided in ISO 8601 format (http://www.iso.org/iso/home/standards/iso8601.htm), e.g. '2015-01-31T23:59:59.999Z'"
                    },
                    "minOrderValue": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "title": "Money Amount",
                        "description": "Minimum order value which entitles the customer to redeem the coupon.",
                        "properties": {
                            "amount": {
                                "type": "number",
                                "default": 0,
                                "minimum": 0,
                                "description": "The total amount in the specified currency."
                            },
                            "currency": {
                                "type": "string",
                                "default": "USD",
                                "pattern": "^[a-z]{3}$",
                                "description": "ISO 4217 currency code, e.g.: USD, EUR, CHF"
                            }
                        }
                    }
                },
                "issuedTo": {
                    "type": "string",
                    "description": "The Id of the customer who originally received the coupon (seller-only)."
                },
                "redemptionCount": {
                    "type": "number",
                    "description": "The number of times a specific coupon has been redeemed. Read-only, set through server. (seller-only)"
                },
                "status": {
                    "enum": [
                        "INACTIVE",
                        "VALID",
                        "EXPIRED",
                        "USED"
                    ],
                    "description": "Current status of the coupon (read-only). 'INACTIVE': the coupon is only valid in the future; 'VALID': can be used; 'EXPIRED': the coupon validity period has expired; 'USED': the maximum number of redemptions for the coupon has been reached."
                },
                "links": {
                    "description": "Hypermedia reference to coupon actions (read-only, customer-only)",
                    "type": "array",
                    "items": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "type": "object",
                        "description": "Hypermedia reference to a resource",
                        "properties": {
                            "rel": {
                                "type": "string",
                                "description": "Link relation type"
                            },
                            "title": {
                                "type": "string",
                                "description": "Link title"
                            },
                            "href": {
                                "type": "string",
                                "description": "Target URI of the link"
                            },
                            "type": {
                                "type": "string",
                                "description": "A content type of the referenced resource"
                            }
                        },
                        "required": [
                            "rel",
                            "title",
                            "href",
                            "type"
                        ]
                    }
                },
                "deleted": {
                    "description": "Flag to mark a coupon as deleted (a.k.a. Soft delete). It is a read-only and seller-only attribute",
                    "type": "boolean"
                }
            },
            "required": [
                "name",
                "discountType",
                "status"
            ]
        }
    }
}

Example:

{
    "laasOffer": {
        "offerId": "f01c2b4295ef4d9284d2e0e8566da8b0",
        "offerType": "COUPON",
        "offerCode": "JX1AQ8X7",
        "name": {
            "en": "JUnit Offer",
            "fr": "JUnit Offer Fr"
        },
        "description": {
            "en": "Junit 18% discount offer",
            "fr": "Junit 18% discount offer fr"
        },
        "validFrom": "2016-04-01T00:00:00.000Z",
        "validTo": "2016-12-31T00:00:00.000Z",
        "emailTemplateId": "GenericOfferEmail",
        "couponTemplateId": "2222",
        "targetGroup": [
            "Silver"
        ],
        "geoFence": [
            "bdc44400241e44fd8cf0f8f867aff5bf",
            "c03c1052320d41e1aad653a66c8baf87",
            "e7ac5f85ce1548e3a3b25cf7210506e6",
            "38a33775fd224c4e8e14bc64b725cbf2"
        ],
        "enableGeoMarketing": true,
        "beacon": [
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 800
            },
            {
                "id": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
                "majorId": 100,
                "minorId": 8001
            }
        ]
    },
    "coupon": {
        "code": "JX1AQ8X7",
        "name": "JX1AQ8X7",
        "discountType": "PERCENT",
        "discountPercentage": "18",
        "allowAnonymous": false,
        "restrictions": {
            "validFrom": "2016-03-29T14:55:27.763Z",
            "validUntil": "2016-12-31T14:55:27.764Z"
        },
        "status": "VALID"
    }
}

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "The request payload has incorrect syntax.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "bad_payload_syntax"
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 404

The requested resource does not exist.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 404,
    "message": "The requested URI does not map to a single element resource.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "element_resource_non_existing"
}

HTTP status code 409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 409,
    "message": "The requested resource could not be updated due to server-side validation.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "conflict_resource"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

Deletes an Offer

Accepted scopes:

'sap.loyoffer.delete' - Required to soft delete Offers

Request
Response

URI Parameters

offerId: required (string)

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 204

The resource has been successfully deleted.

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 404

The requested resource does not exist.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 404,
    "message": "The requested URI does not map to a single element resource.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "element_resource_non_existing"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

/offers/index

post

Creates all Offer indices required for Elastic Search

Accepted scopes:

'sap.loyoffer.manage' - Required to create elastic search indices for Offers

Creates all Offer indices required for Elastic Search

Accepted scopes:

'sap.loyoffer.manage' - Required to create elastic search indices for Offers

Request
Response

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

/locationOffers

This resourceType defines the POST, PUT methods and their responses for a collection resource.

/locationOffers

post

Gets Offers based on Geo Location like longitude, latitude and radius. Additionally, memberId can also be passed to fetch offers for a particular memberId

Accepted scopes:

'sap.loyoffer.manage' - Required to query Offers

Gets Offers based on Geo Location like longitude, latitude and radius. Additionally, memberId can also be passed to fetch offers for a particular memberId

Accepted scopes:

'sap.loyoffer.manage' - Required to query Offers

Request
Response

Headers

Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
```
pl
```
hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
```
en,pl,it
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Offers by Location",
    "type": "object",
    "properties": {
        "longitude": {
            "type": "number"
        },
        "latitude": {
            "type": "number"
        },
        "radius": {
            "type": "integer"
        },
        "memberId": {
            "type": "string"
        }
    },
    "required": [
        "longitude",
        "latitude",
        "radius"
    ]
}

Example:

{
    "latitude": 50.8183581,
    "longitude": -3.3042133,
    "radius": 1000
}

HTTP status code 201

The collection resource has been successfully created.

Headers

Location: required (string)
The Location of the new resource which was created by the request. The value consists of a single absolute URI.
Example:
```
http://www.hybris.com/items/myItem
```

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "The request payload has incorrect syntax.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "bad_payload_syntax"
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 409,
    "message": "The requested resource could not be created due to server-side validation.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "conflict_resource"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

/beaconOffers

This resourceType defines the POST, PUT methods and their responses for a collection resource.

/beaconOffers

post

Gets Offers based on Beacon Information like Id, majorId and minorId. Additionally, memberId can also be passed to fetch offers for a particular memberId

Accepted scopes:

'sap.loyoffer.manage' - Required to query Offers

Gets Offers based on Beacon Information like Id, majorId and minorId. Additionally, memberId can also be passed to fetch offers for a particular memberId

Accepted scopes:

'sap.loyoffer.manage' - Required to query Offers

Request
Response

Headers

Accept-Language: (string - repeat: true)
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
Example:
```
pl
```
hybris-languages: (string - repeat: true)
Comma separated list of language identifiers for which the localization for an attribute should be provided.
Example:
```
en,pl,it
```
Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Beacon Offers",
    "type": "object",
    "properties": {
        "beaconId": {
            "type": "string"
        },
        "majorId": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535
        },
        "minorId": {
            "type": "integer",
            "minimum": 1,
            "maximum": 65535
        },
        "memberId": {
            "type": "string"
        }
    },
    "required": [
        "beaconId"
    ]
}

Example:

{
    "beaconId": "B9407F30-F5F8-466E-AFF9-25556B57FE6D",
    "majorId": 100,
    "minorId": 8001
}

HTTP status code 201

The collection resource has been successfully created.

Headers

Location: required (string)
The Location of the new resource which was created by the request. The value consists of a single absolute URI.
Example:
```
http://www.hybris.com/items/myItem
```

HTTP status code 400

Request syntactically incorrect. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 400,
    "message": "The request payload has incorrect syntax.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "bad_payload_syntax"
}

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

HTTP status code 409

Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 409,
    "message": "The requested resource could not be created due to server-side validation.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "conflict_resource"
}

HTTP status code 500

Some server side error occurred.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 500,
    "message": "Something went wrong while processing the request. Please contact the administrator.",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html",
    "type": "internal_service_error"
}

/migration

get

Migrates offer data to relevant format for the latest release

Accepted scopes:

'sap.loyoffer_view' - Required to do read operations

Migrates offer data to relevant format for the latest release

Accepted scopes:

'sap.loyoffer_view' - Required to do read operations

Request
Response

Headers

Authorization: required (string)
Used to send a valid OAuth2 access token.
Example:
```
Bearer access_token
```

HTTP status code 200

Body

Type: application/json

HTTP status code 401

Given request is unauthorized. Bad or expired token. Reauthenticate the user. Any details will be provided within the response payload.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 401,
    "message": "Authorization: Unauthorized. Bearer TOKEN is invalid",
    "type": "insufficient_credentials",
    "moreInfo": "https://api.yaas.io/patterns/errortypes.html"
}

HTTP status code 403

Evaluated request scopes in access token are not sufficient and do not match required scopes.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "error",
    "description": "Schema for API specified errors.",
    "type": "object",
    "properties": {
        "status": {
            "type": "integer",
            "description": "original HTTP error code, should be consistent with the response HTTP code",
            "minimum": 100,
            "maximum": 599
        },
        "type": {
            "type": "string",
            "description": "classification of the error type, lower case with underscore eg validation_failure",
            "pattern": "[a-z]+[a-z_]*[a-z]+"
        },
        "message": {
            "type": "string",
            "description": "descriptive error message for debugging"
        },
        "moreInfo": {
            "type": "string",
            "format": "uri",
            "description": "link to documentation to investigate further and finding support"
        },
        "details": {
            "type": "array",
            "description": "list of problems causing this error",
            "items": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "title": "errorDetail",
                "description": "schema for specific error cause",
                "type": "object",
                "properties": {
                    "field": {
                        "type": "string",
                        "description": "a bean notation expression specifying the element in request data causing the error, eg product.variants[3].name, this can be empty if violation was not field specific"
                    },
                    "type": {
                        "type": "string",
                        "description": "classification of the error detail type, lower case with underscore eg missing_value, this value must be always interpreted in context of the general error type.",
                        "pattern": "[a-z]+[a-z_]*[a-z]+"
                    },
                    "message": {
                        "type": "string",
                        "description": "descriptive error detail message for debugging"
                    },
                    "moreInfo": {
                        "type": "string",
                        "format": "uri",
                        "description": "link to documentation to investigate further and finding support for error detail"
                    }
                },
                "required": [
                    "type"
                ]
            }
        }
    },
    "required": [
        "status",
        "type"
    ]
}

Example:

{
    "status": 403,
    "message": "Given request does not have required scopes in access token. It is not authorized to perform this operation.",
    "type": "insufficient_permissions"
}

/offers
/locationOffers
/beaconOffers
/migration

Error Types

For more information about error codes, see the detailed error description for each API operation in API Reference. You can also check the standard error codes at API best practices.

Scopes

Scopes are strings that let you specify exactly what type of access you need to resources and operations in the Loyalty offer service.

You must provide a proper scope that enables users to perform certain operations. The scopes should be granted in an access token from OAuth 2.0 service. For more information about the authorization and authentication used in hybris services, and also about the scopes in general, see: Authorization Scopes

The table presents all the scopes supported by the Loyalty Offer service.

Scope	Description
sap.loyoffer_view	Use this scope to view existing offers.
sap.loyoffer_manage	Use this scope to create or modify existing offers.
sap.loyoffer_delete	Use this scope to delete an existing offer.

Perform Simple CRUD Operations on Offers Object

Introduction

With the Loyalty Offer service you can do all the necessary operations to manage your offers: create, retrieve, update, and delete. To perform the basic operations supported by the iBeacon service, you need to be properly authorized. This is achieved through the header that carries the correct access token. The examples in this tutorial will lead you through those operations, showing what you need to provide to the methods, and what you get in return.

clientId = clientIdPlaceholder;
clientSecret = clientSecretPlaceholder;
tenant = projectIdPlaceholder;
client = appIdPlaceholder;
scopesRequired = 'hybris.tenant='+tenant+' sap.loyoffer_view sap.loyoffer_manage sap.loyoffer_delete';
token = tokenPlaceholder;

Get access token

To perform any operations with a specific service, you always need an access token. For this purpose, create an API Client for the oAuth2 service:

API.createClient('oAuth2Service',
'/services/oauth2/v1/api.raml');

Now get the token:

AccessToken = oAuth2Service.token.post({
  'client_id' : clientId,
  'client_secret': clientSecret,
  'grant_type' : 'client_credentials',
  'token_type': 'Bearer',
  'scope': scopesRequired
});

access_token = AccessToken.body.access_token;

Create API client for Loyalty Offer service

API.createClient('offerService',
'/services/loyaltyoffer/v1/api.raml');

randomStringCouponCode = function() {
                    var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZabcdefghiklmnopqrstuvwxyz';
                    var stringLength = 8;
                    var randomstring = '';
                    for (var i = 0; i < stringLength; i++) {
                        var rnum = Math.floor(Math.random() * chars.length);
                        randomstring += chars.substring(rnum, rnum + 1);
                    }
                    return randomstring;
                }

offerCouponCode = randomStringCouponCode();

Create an Offer object

offer_obj = offerService.offers.post({
'laasOffer':
{
  'offerId':'f01c2b4295ef4d9284d2e0e8566da8b0',
  'offerType':'COUPON',
  'offerCode':offerCouponCode,
  'name':
  { 
     'en': 'API Tutorial Offer'
   },
  'description': 
  {
    'en': 'Playbook API tutorial offer'
  },
  'validFrom':'2016-04-01T00:00:00.000Z',
  'validTo':'2016-12-31T00:00:00.000Z',
  'emailTemplateId': 'GenericOfferEmail',
  'couponTemplateId': '2222',
  'targetGroup': ['Silver' ],
  'enableGeoMarketing': true,
  'geoFence': [ 'bdc44400241e44fd8cf0f8f867aff5bf',
               'c03c1052320d41e1aad653a66c8baf87',
               'e7ac5f85ce1548e3a3b25cf7210506e6',
               '38a33775fd224c4e8e14bc64b725cbf2' ],
  'beacon':
  [
    {
      'id':'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
      'majorId':8000,
      'minorId':100
    },
   {
      'id':'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
      'majorId':8000,
      'minorId':200
    }
  ]
},
'coupon':
  {
  'code': offerCouponCode,
  'name': offerCouponCode,
  'discountType': 'PERCENT',
  'discountPercentage': '10',
  'allowAnonymous': false,
  'restrictions': {
      'validFrom': '2016-03-29T14:55:27.763Z',
      'validUntil': '2016-12-31T14:55:27.764Z'
  },
  'status': 'VALID'
}
}, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

Retrieve object created with the previous step

  path = offer_obj.headers.location.split('/').reverse();
  offerId = path[0];
  offerService.offers.offerId(offerId).get(null, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

Update the Offer object

Perform a partial update on the object:

offerService.offers.offerId(offerId).put({
  'laasOffer':
{
  'offerId':'f01c2b4295ef4d9284d2e0e8566da8b0',
  'offerType':'COUPON',
  'offerCode':'JX1AQ127',
  'name':
  { 
     'en': 'API Tutorial Offer update'
   },
  'description': 
  {
    'en': 'Playbook API tutorial offer'
  },
  'validFrom':'2016-04-01T00:00:00.000Z',
  'validTo':'2016-12-31T00:00:00.000Z'
}
}, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           },
  query: {
    'partial' : true
  }
    }
  )

Retrieve the same Offer object to ensure that proper information is updated

Get the Offer object to make sure that it was updated.

offerService.offers.offerId(offerId).get(null, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

Retrieve the same Offer object to ensure that proper information is updated

Get the Offer object to make sure that it was updated.

offerService.offers.laasOffer.laasOfferId(offerId).get(null, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

Delete the above Offer Object

offerService.offers.offerId(offerId).delete(null, {
  headers: {
   'Authorization': 'Bearer ' + access_token,
  }
})

Retrieve the deleted offer object to ensure the offer status is set to INACTIVE (soft delete)

offer_object = offerService.offers.offerId(offerId).get(null, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )
offer_object.body.laasOffer.offerStatus

Get offers based on geofence Location

Introduction

With the Loyalty Location Offer service, we can get offers based on geofence details:

clientId = clientIdPlaceholder;
clientSecret = clientSecretPlaceholder;
tenant = projectIdPlaceholder;
client = appIdPlaceholder;
scopesRequired = 'hybris.tenant='+tenant+' sap.loyoffer_view sap.loyoffer_manage sap.loyoffer_delete';
token = tokenPlaceholder;

Get access token

To perform any operations with a specific service, you always need an access token. For this purpose, create an API client for the oAuth2 service:

API.createClient('oAuth2Service',
'/services/oauth2/v1/api.raml');

Now get the token:

AccessToken = oAuth2Service.token.post({
  'client_id' : clientId,
  'client_secret': clientSecret,
  'grant_type' : 'client_credentials',
  'token_type': 'Bearer',
  'scope': scopesRequired
});

access_token = AccessToken.body.access_token;

Create API client for Loyalty Offer service

API.createClient('locationOfferService',
'/services/loyaltyoffer/v1/api.raml');

Get Offers based on geofence Location.

Change latitude, longitude and radius values as per your project while testing end point.

Location_obj = locationOfferService.locationOffers.post({
    'latitude':48.1333,
    'longitude': 11.5667,
    'radius':5000
}, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

Get Offers based on IBeacon

Introduction

With the Loyalty iBeacon Offer service, we can get offers based on iBeacon details:

clientId = clientIdPlaceholder;
clientSecret = clientSecretPlaceholder;
tenant = projectIdPlaceholder;
client = appIdPlaceholder;
scopesRequired = 'hybris.tenant='+tenant+' sap.loyoffer_view sap.loyoffer_manage sap.loyoffer_delete';
token = tokenPlaceholder;

Get access token

To perform any operations with a specific service, you always need an access token. For this purpose, create an API client for the oAuth2 service:

API.createClient('oAuth2Service',
'/services/oauth2/v1/api.raml');

Now get the token:

AccessToken = oAuth2Service.token.post({
  'client_id' : clientId,
  'client_secret': clientSecret,
  'grant_type' : 'client_credentials',
  'token_type': 'Bearer',
  'scope': scopesRequired
});

access_token = AccessToken.body.access_token;

Create API client for Loyalty Offer service

API.createClient('beaconOfferService',
'/services/loyaltyoffer/v1/api.raml');

Get Offers based on iBeacon details.

Change beaconId, majorId and minorId values as per your project while testing end point.

Location_obj = beaconOfferService.beaconOffers.post({
     'beaconId':'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
    'majorId':8000,
    'minorId':100
}, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

Send feedback
If you find any information that is unclear or incorrect, please let us know so that we can improve the Dev Portal content.
Get Help
Use our private help channel. Receive updates over email and contact our specialists directly.
hybris Experts
If you need more information about this topic, visit hybris Experts to post your own question and interact with our community and experts.

Overview

API Reference

/offers

/offers

get /offers

Headers

Query Parameters

HTTP status code 200

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 500

Body

post /offers

Headers

Body

HTTP status code 201

Headers

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 409

Body

HTTP status code 500

Body

/offers/aggr

get /offers/aggr

Headers

Query Parameters

HTTP status code 200

Headers

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

/offers/search

post /offers/search

Headers

Body

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

Body

/offers/laasOffer/{laasOfferId}

get /offers/laasOffer/{laasOfferId}

URI Parameters

Headers

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 404

Body

HTTP status code 500

Body

put /offers/laasOffer/{laasOfferId}

URI Parameters

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body