Download OpenAPI specification:Download
Welcome to the Skeepers Purchase Events API documentation!
This API allows you to easily share your business' purchase events with Skeepers, including online store orders and in-store purchases.
A key step towards gathering valuable User-Generated Content (UGC)! This data empowers Skeepers to gain deeper insights into your customers and their recent purchases, enabling us to send them personalized invitations to collect precious feedback.
This documentation provides clear examples and guidance on how to use the API's individual endpoints.
The base URL for accessing the Purchase Events API is:
https://api.skeepers.io/purchase-event/
Authentication is required to use the Purchase Events API. Follow the step-by-step guide below to retrieve your API credentials, obtain an access token, and use it to authenticate your requests.
To begin, log in to your Ratings & Reviews account: https://app.netreviews.eu/
To obtain an access token, make a POST request to the authentication endpoint as follows:
Authentication endpoint
https://auth.skeepers.io/am/oauth2/alpha/access_token
Header Parameters
Authorization: Basic <base64 encoded "clientId:clientSecret">
Content-Type: application/x-www-form-urlencoded
Replace <base64 encoded "clientId:clientSecret">
with the Base64-encoded value of your API credentials (Client ID and Client secret).
Request Parameters
grant_type: client_credentials
scope: openid
Example
POST https://auth.skeepers.io/am/oauth2/alpha/access_token HTTP/1.1
Authorization: Basic <base64 encoded "clientId:clientSecret">
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&scope=openid
Once you've obtained the access token, include it in the Authorization header of all your requests to the Purchase Events API as follows:
Authorization: Bearer <access_token>
Replace <access_token>
with the actual access token you received from the previous step.
Great job! You are now ready to make authenticated requests to the Purchase Events API.
Let's explore the methods below!
Submit one or multiple purchase events within a single request.
Note: Maximum 50 purchase events per request.
website_id required | string <uuid> Example: d0accd7e-32c8-11ee-be56-0242ac120002 The ID of the website. |
Array of purchase events
purchase_reference required | string [ 1 .. 50 ] characters The reference of the purchase. |
purchase_date required | string <date-time> The date of the purchase. |
price | number Default: 0 The amount of the purchase. |
required | object (Consumer Schema) Information about the consumer who made the purchase. |
Array of objects or null (Product Schema) List of products associated with the purchase event. | |
required | object (Sales Channel Schema) Information about where the purchase was made. |
object (Solicitation Parameters Schema) Setup for the review request that will be sent. | |
Array of objects or null (Custom Fields Schema) Custom fields associated with the purchase event. |
[- {
- "purchase_reference": "#1855",
- "purchase_date": "2022-05-27T14:15:22Z",
- "price": 145.9,
- "consumer": {
- "first_name": "John",
- "last_name": "Smith",
- "birth_date": "1985-06-15",
- "email": "john.smith@example.com",
- "phone": "+123456789",
- "courtesy_title": "Mr",
- "custom_fields": [
- {
- "label": "Preferred Color",
- "value": "Blue",
- "category": "Preferences"
}
], - "language": "en",
- "country": "US"
}, - "products": [
- {
- "product_ref": {
- "ean": "978020137962",
- "sku": "UGG-BB-PUR-06",
- "upc": "03600029145x12",
- "isbn": "978-3-16-148410-0",
- "jan": "978020137962",
- "mpn": "00638HAT",
- "reference": "PROD1234"
}, - "name": "Product 1",
- "brand": "Brand A",
- "price": 39.9,
- "custom_fields": [
- {
- "label": "Product Color",
- "value": "Red",
- "category": "Product Details"
}
], - "category": "Electronics"
}, - {
- "product_ref": {
- "ean": "978020137963",
- "sku": "UGG-BB-PUR-07",
- "upc": "03600029145x13",
- "isbn": "978-3-16-148410-1",
- "jan": "978020137963",
- "mpn": "00638HAT2",
- "reference": "PROD5678"
}, - "name": "Product 2",
- "brand": "Brand A",
- "not_received": true,
- "price": 59.9,
- "custom_fields": [
- {
- "label": "Product Color",
- "value": "Blue",
- "category": "Product Details"
}
], - "category": "Electronics"
}
], - "sales_channel": {
- "channel": "online",
- "delivery_type": "home_delivery",
- "website_id": "d0accd7e-32c8-11ee-be56-0242ac120002"
}, - "solicitation_parameters": {
- "delay": 3,
- "delay_product": 5,
- "purchase_event_type": "BRAND_AND_PRODUCT"
}, - "custom_fields": [
- {
- "label": "Payment Method",
- "value": "Credit Card",
- "category": "Order Details"
}
]
}, - {
- "purchase_reference": "#1860",
- "purchase_date": "2022-10-01T12:00:00Z",
- "price": 50,
- "consumer": {
- "first_name": "Michael",
- "last_name": "Johnson",
- "email": "michael.johnson@example.com"
}, - "products": [
- {
- "product_ref": {
- "reference": "PROD1111"
}, - "name": "Product 6",
- "brand": "Brand E",
- "price": 25
}
], - "sales_channel": {
- "channel": "offline",
- "website_id": "d0accd7e-32c8-11ee-be56-0242ac120002",
- "shop_id": "store_1811"
}
}
]
[- {
- "id": "026bf31c-32ce-11ee-be56-0242ac120002",
- "website_id": "d0accd7e-32c8-11ee-be56-0242ac120002",
- "purchase_reference": "#1855",
- "purchase_date": "2022-05-27T14:15:22Z",
- "price": 145.9,
- "purchase_event_status": "CREATED",
- "consumer": {
- "hide_personal_data": false,
- "anonymize_data": false,
- "first_name": "John",
- "last_name": "Smith",
- "birth_date": "1985-06-15",
- "email": "john.smith@example.com",
- "phone": "+123456789",
- "courtesy_title": "Mr",
- "custom_fields": [
- {
- "label": "Preferred Color",
- "value": "Blue",
- "category": "Preferences"
}
], - "language": "en",
- "country": "US"
}, - "products": [
- {
- "product_ref": {
- "ean": "978020137962",
- "sku": "UGG-BB-PUR-06",
- "upc": "03600029145x12",
- "isbn": "978-3-16-148410-0",
- "jan": "978020137962",
- "mpn": "00638HAT",
- "reference": "PROD1234"
}, - "name": "Product 1",
- "brand": "Brand A",
- "price": 39.9,
- "custom_fields": [
- {
- "label": "Product Color",
- "value": "Red",
- "category": "Product Details"
}
], - "category": "Electronics"
}, - {
- "product_ref": {
- "ean": "978020137963",
- "sku": "UGG-BB-PUR-07",
- "upc": "03600029145x13",
- "isbn": "978-3-16-148410-1",
- "jan": "978020137963",
- "mpn": "00638HAT2",
- "reference": "PROD5678"
}, - "name": "Product 2",
- "brand": "Brand A",
- "not_received": true,
- "price": 59.9,
- "custom_fields": [
- {
- "label": "Product Color",
- "value": "Blue",
- "category": "Product Details"
}
], - "category": "Electronics"
}
], - "sales_channel": {
- "channel": "online",
- "delivery_type": "home_delivery",
- "website_id": "d0accd7e-32c8-11ee-be56-0242ac120002"
}, - "solicitation_parameters": {
- "delay": 3,
- "delay_product": 5,
- "purchase_event_type": "BRAND_AND_PRODUCT"
}, - "custom_fields": [
- {
- "label": "Payment Method",
- "value": "Credit Card",
- "category": "Order Details"
}
]
}, - {
- "id": "026bf31c-32ce-11ee-be56-0242ac120002",
- "website_id": "d0accd7e-32c8-11ee-be56-0242ac120002",
- "purchase_reference": "#1860",
- "purchase_date": "2022-10-01T12:00:00Z",
- "price": 50,
- "purchase_event_status": "CREATED",
- "consumer": {
- "first_name": "Michael",
- "last_name": "Johnson",
- "email": "michael.johnson@example.com"
}, - "products": [
- {
- "product_ref": {
- "reference": "PROD1111"
}, - "name": "Product 6",
- "brand": "Brand E",
- "price": 25
}
], - "sales_channel": {
- "channel": "offline",
- "website_id": "d0accd7e-32c8-11ee-be56-0242ac120002",
- "shop_id": "store_1811"
}
}
]