Blooms Loyalty Store API Endpoints

Staging version

The Store API Endpoints will be used by POSWorks to integrate with the Blooms loyalty system for the customer registration and redemption processes.

Refer to the flow diagram here

- - V 1.0 Interactive API documentation
    - API endpoints for customer registration/updates and the loyalty redemption flows

Access to the Store API Endpoints are restricted and require authorization tokens. Tokens can be obtained via the identity authority below.
Note: Tokens expire at short intervals (currently set to 1 hour).

Client credentials same as previously provided to POSWorks

Show/Hide

post < IDENTITY-AUTHORITY-PATH > /connect/token

API call to get authorisation token to access the store API endpoints

Identity Authority

[ Path ] https://blooms-identity.hollersydney.com.au

Request

[ Content type ] application/x-www-form-urlencoded

Parameters	Example code snippets
client_id required To be provided client_secret required To be provided grant_type required client_credentials scope required blooms_store_api	HTTP POST /connect/token HTTP/1.1 Host: <identity-authority-path> Content-Type: application/x-www-form-urlencoded Cache-Control: no-cache client_id=<client-id>&client_secret=<client-secret>&grant_type=client_credentials&scope=blooms_store_api cURL curl -X POST \ <identity-authority-path>/connect/token \ -H 'cache-control: no-cache' \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'client_id=<client-id>&client_secret=<client-secret>&grant_type=client_credentials&scope=blooms_store_api'

Parameters

Example code snippets

client_id required

To be provided

client_secret required

To be provided

grant_type required

client_credentials

scope required

blooms_store_api

HTTP

POST /connect/token HTTP/1.1
Host: <identity-authority-path>
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

client_id=<client-id>&client_secret=<client-secret>&grant_type=client_credentials&scope=blooms_store_api

cURL

curl -X POST \
<identity-authority-path>/connect/token \
    -H 'cache-control: no-cache' \
    -H 'content-type: application/x-www-form-urlencoded' \
    -d 'client_id=<client-id>&client_secret=<client-secret>&grant_type=client_credentials&scope=blooms_store_api'

Response

[ Content type ] application/json

HTTP Status Code	Reason	Response Model
200	Success	ErrorGetResponse { error (string, optional) } `{ "access_token": "string", "expires_in": number, "token_type": "string" }`
400	Bad Request	ErrorGetResponse { error (string, optional) } `{ "error": "string" }`

An AWS S3 bucket has been setup to securely upload all data files from the POSWorks HQ at regular intervals.
The S3 bucket and has been configured with restricted access and will encrypt all files at rest.

Access credentials same as previously provided to POSWorks

Show/Hide

info S3 Bucket Setup Details

Setup details and useful links

Bucket Name

blooms-posworks-data-upload

Bucket Region

ap-southeast-2

Access credentials

Provided

Data Files to be Uploaded

File	Description	Expected Format
Store	Store updates	Store_{YYYYMMDD}_{Unique-Timestamp}.json
User	Store staff updates	User_{YYYYMMDD}_{Unique-Timestamp}.json
Item	Product updates	Item_{YYYYMMDD}_{Unique-Timestamp}.json
Category	Product category updates	Category_{YYYYMMDD}_{Unique-Timestamp}.json
TranHeader	Transaction header updates	TranHeader_{YYYYMMDD}_{Unique-Timestamp}.json
TranDetail	Transaction details updates	TranDetail_{YYYYMMDD}_{Unique-Timestamp}.json
TranTender	Transaction tender updates	TranTender_{YYYYMMDD}_{Unique-Timestamp}.json
SpecialHeader	Special promotion updates	SpecialHeader_{YYYYMMDD}_{Unique-Timestamp}.json

- - Integrating with AWS S3
  - S3 Amazon Simple Storage Service Documentation
  - SDK Tools for Amazon Web Services
  - PUT S3 PUT Object

An AWS S3 bucket has been setup for POSWorks to securely download customer update files at regular intervals.
The S3 bucket and has been configured with restricted access and will encrypt all files at rest.

Note: Customer data files will generated at 8-hour intervals and will be set to expire and be removed from the S3 bucket 24 hours from the time of creation.

Access credentials same as previously provided to POSWorks

Show/Hide

info S3 Bucket Setup Details

Setup details

Bucket Name

blooms-posworks-data-download

Bucket Region

ap-southeast-2

Access credentials

Provided

Data Files available to Download

File	Description	Expected Format
Customer	Customer updates	Customer_{YYYYMMDD}_{Unique-Timestamp}.json

Data format

Fields JSON format

Fields	JSON format
UpdateDate Timestamp when the customer record was updated Format: YYYY-MM-DD HH:MM:SS CustomerId Unique ID of customer in the loyalty system PosCustomerId Unique ID of customer at POSWorks (if available) PosStoreId Unique ID of store at POSWorks (if available) CardNumber Card Number of customer FirstName First name of customer LastName Last name of customer Email Email of customer PhoneNumber Phone number of customer Gender Customer's gender Possible values: Male, Female, Other BirthDate Customer's date of birth Format: YYYY-MM-DD Address Customer's address Suburb Customer's suburb State Customer's state Postcode Customer's postode	`[ { "UpdateDate": "string", "CustomerId": "string", "PosCustomerId": "string", "PosStoreId": "string", "CardNumber": "string", "FirstName": "string", "LastName": "string", "Email": "string", "PhoneNumber": "string", "Gender": "string", "BirthDate": "string", "Address": "string", "Suburb": "string", "State": "string", "Postcode": "string" } ... ]` Download sample file here.

UpdateDate

Timestamp when the customer record was updated
Format: YYYY-MM-DD HH:MM:SS

CustomerId

Unique ID of customer in the loyalty system

PosCustomerId

Unique ID of customer at POSWorks (if available)

PosStoreId

Unique ID of store at POSWorks (if available)

CardNumber

Card Number of customer

FirstName

First name of customer

LastName

Last name of customer

Email of customer

PhoneNumber

Phone number of customer

Gender

Customer's gender
Possible values: Male, Female, Other

BirthDate

Customer's date of birth
Format: YYYY-MM-DD

Address

Customer's address

Suburb

Customer's suburb

State

Customer's state

Postcode

Customer's postode

[
  {
    "UpdateDate": "string",
    "CustomerId": "string",
    "PosCustomerId": "string",
    "PosStoreId": "string",
    "CardNumber": "string",
    "FirstName": "string",
    "LastName": "string",
    "Email": "string",
    "PhoneNumber": "string",
    "Gender": "string",
    "BirthDate": "string",
    "Address": "string",
    "Suburb": "string",
    "State": "string",
    "Postcode": "string"
  }
  ...
]

Download sample file here.

Store Register API Endpoints

V 1.0 Interactive API documentation

Authorisation Token Provider

post < IDENTITY-AUTHORITY-PATH > /connect/token

Identity Authority

Request

Response

Secure Data File Uploads

info S3 Bucket Setup Details

Bucket Name

Bucket Region

Access credentials

Data Files to be Uploaded

Integrating with AWS S3

S3 Amazon Simple Storage Service Documentation

SDK Tools for Amazon Web Services

PUT S3 PUT Object

Secure Data File Downloads

info S3 Bucket Setup Details

Bucket Name

Bucket Region

Access credentials

Data Files available to Download

Data format