Get StoreOffer - Synap API (Beta)

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (StoreOffer)

required

id

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

StoreOffer

Example:

StoreOffer

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "StoreOffer",
        "attributes": {
            "title": "string",
            "description": "string",
            "externalId": "string",
            "offerItems": [
                {
                    "type": "product",
                    "targetId": "string",
                    "productIdentifier": "string"
                }
            ],
            "offerSettings": {
                "selectionType": "all",
                "maxRedemptionsPerUser": 0,
                "promoCodePrefix": "string",
                "accessInstructions": {
                    "accessUntilDate": "2019-08-24T14:15:22Z"
                },
                "conflictHandling": {
                    "disableIfClaimed": [
                        "string"
                    ]
                }
            }
        },
        "relationships": {
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error