POST /stores¶
Post a new store.
Body parameters:
Name |
Type |
Description |
---|---|---|
|
integer, optional, min: 1 |
the legacy retailer-specific store identifier |
|
string, optional, min: 1, max: 255 |
the retailer-specific store identifier |
|
string, required, min: 1, max: 100 |
the descriptive name for this store |
|
array of strings, optional |
an array of address lines |
|
string, optional, min: 1, max: 60 |
name of the city in which this store is located |
|
string, optional, min: 1, max: 10 |
the postcode matching this store’s address |
|
string, required, ISO 3166-1 or ISO 3166-3 alpha-3 country code |
code of the country in which this store is located |
|
string, optional, min: 1, max: 20 |
a telephone number for contacting this store |
|
string, optional |
the locale for this store |
|
string, optional |
IANA time zone name |
|
string, optional, ISO 4217 alpha-3 currency code |
ISO 4217 currency code |
|
JSON type, optional |
the properties for this store |
|
JSON type, optional |
the settings for this store |
Example request:
POST /stores HTTP/1.1
Host: api.ereceipts.co.uk
Content-Length: 271
Content-Type: application/json
{
"address": [
"99 Foo St"
],
"city": "London",
"country": "GBR",
"locale": "en_GB",
"name": "Test Store",
"phone": "+440000000000",
"postcode": "W124AF",
"properties": {
"type": "outlet"
},
"reference": 1001,
"timezone": "Europe/London"
}
Example response:
The response contains the new store’s reference.
HTTP/1.1 201 Created
Content-Length: 19
Content-Type: application/json
Location: https://api.ereceipts.co.uk/stores/1001
{"reference": 1001}