Use Offer

Uses (activates) the offer by member.

Query Parameters

Parameter	Type	Required?	Default	Description
scope	enum	no	`standard`	Determines the scope the API operates on. See Offers scoping

Body Parameters

Key	Type	Optional?	Description
authorization_token	string	yes	See below

Offer use authorization

Some features (like Rewards Program) may require from member to provide some code (scanned QR code, for example) sent as
authorization_token param, so we can register his physical presence in the store.

Depending on specific offer setup, the token may be required to register usage or be optional.

When it's required (authorization_token_required is true), it's impossible to register usage.

When it's optional and token is not provided, the offer use is processed as usual, except that some benefits (like Rewards points)
tied to it may not be granted to the member.

Response Body

Key	Type	Description
usage	OfferUsage	See Offer usage model

Error Responses

Status	Response body	Description
`404`	`{"error": "Offer#10000951 not found"}`	-
`422`	`{"error": "Already active"}`	The offer has been just used
`422`	`{"error": "Not granted"}`	The offer is not available to member
`422`	`{"error": "Usage authorization token missing"}`	Usage token is missing
`422`	`{"error": "Usage authorization token invalid"}`	Provided usage token is invalid
`422`	`{"error": "User limit exceeded"}`	Member exhausted his pool of uses
`422`	`{"error": "Periodic user limit exceeded"}`	Member exhausted his pool of uses within current time period
`422`	`{"error": "Global limit exceeded"}`	There are no more offers available globally (stock is empty)
`422`	`{"error": "Not in usable timeframes"}`	Offer is not usable yet or anymore
`467`	`{"error": "Member is banned!", "banned_until": "2137-10-28T17:24:06.207Z"}`	Member is banned

Example

When successful, returns a Offer usage object - See Offer usage model

{
    "usage": {
        "usable": true,
        "max_uses": 100,
        "uses_left": 68,
        "active_until": "2019-05-08T14:47:22.323Z"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

Query Parameters#

Body Parameters#

Offer use authorization#

Response Body#

Error Responses#

Example#

Request