Stores Last updated: 2020-09-10

The Store resource stores information about a merchant's brick and mortar storefronts including address, open and close times, inventory availability and photos.

What you can do with stores:
Store Properties
Property Description
OID "OID":  12321
The marketAgility ID for the store
SiteID "SiteID":  1
The marketAgility Site Id for the store
Name "Name":  "Reston Town Center"
The name of the store
Created "Created":  "2019-04-21T12:43:12"
The date the store was created
Modified "Modified":  "2020-05-12T08:03:00"
The date the store was last modified
Status "Status":  "Active"
Defines whether a store is active or inactive
OnlineStatus "OnlineStatus":  "Migrating"
The live status of a store (Staging, Migrating, Production)
OnlineDate "OnlineDate":  "2020-05-05T18:03:00"
The date and time this store was last updated in the production environment
UrlIdentifier "UrlIdentifier":  "12005-reston-va"
The unique url of the store
StoreNumber "StoreNumber":  "12005"
The merchant-assigned store number
Address "Address":  "12005 Sunrise Valley Drive"
Address Line 1 of the store
Address2 "Address2":  "Suite 400"
Address Line 2 of the store
City "City":  "Reston"
The city of the store
StateOrProvince "StateOrProvince":  "VA"
The State Or Province ISO code
PostalCode "PostalCode":  "20191"
The postal code
Country "Country":  "US"
ISO Country Code
Phone "Phone":  "703-689-2121"
The phone number of the store
Hours "Address2":  "M-F 9 AM through 10 PM. Closed Saturday and Sunday"
Text representation of the hours of operation
URL "URL":  "https://www.myindividualstoresite.com"
An external url to a store specific website
Email "Email":  "[email protected]"
Email Address of the store
OpenDate "OpenDate":  "2015-05-25T07:00:00"
The date the store first opened
IsBOPISEnabled "IsBOPISEnabled":  true
Is Buy Online Pickup In Store (BOPIS) enabled for this store
IsSTSEnabled "IsSTSEnabled":  false
Is Ship To Store (STS) enabled for this store
IsSFSEnabled "IsSFSEnabled":  false
Is Ship From Store (SFS) enabled for this store
BagFee.SKU "Fee":  "12321657"
The SKU that should be used when adding a BOPIS Bag Fee to the order
BagFee.Fee "Fee":  false
The amount per sku that should be assessed when adding a BOPIS bag fee. To remove an existing bag fee, set this value to zero.
BagFee.FeeType "FeeType":  "PerItem"
Should the BOPIS bag fee be assessed per order or per item?
Latitude "Latitude":  38.932
The latitudinal coordinate of the store
Longitude "Longitude":  -77.3386
The longitudinal coordinate of the store
Description "Description":  "Located at the end of the food court, this store offers full service shopping, returns, and gift wrapping services."
Description of the store
FullImage "FullImage":  "https://mabaseline.blob.core.windows.net/images/stores/1_2649_fs_default.jpg""
The Url of the full sized view of the store
PreviewImage "PreviewImage":  "https://mabaseline.blob.core.windows.net/images/stores/1_2649_th_default.jpg"
The Url of the thumbnail view of the store
Badges "Badges":  "["Just Opened"]"
An Array of badge names applied to the store
Timezone "Timezone":  "Eastern Standard Time"
Time Zone the store operates under
SundayOpen "SundayOpen":  ""
The time the store opens on Sunday
SundayClose "SundayClose":  ""
The time the store closes on Sunday
MondayOpen "MondayOpen":  "9:00 AM"
The time the store opens on Monday
MondayClose "MondayClose":  "6:00 PM"
The time the store closes on Monday
TuesdayOpen "TuesdayOpen":  "9:00 AM"
The time the store opens on Tuesday
TuesdayClose "TuesdayClose":  "6:00 PM"
The time the store closes on Tuesday
WednesdayOpen "WednesdayOpen":  "9:00 AM"
The time the store opens on Wednesday
WednesdayClose "WednesdayClose":  "6:00 PM"
The time the store closes on Wednesday
ThursdayOpen "ThursdayOpen":  "9:00 AM"
The time the store opens on Thursday
ThursdayClose "ThursdayClose":  "6:00 PM"
The time the store closes on Thursday
FridayOpen "FridayOpen":  "9:00 AM"
The time the store opens on Friday
FridayClose "FridayClose":  "6:00 PM"
The time the store closes on Friday
SaturdayOpen "SaturdayOpen":  "9:00 AM"
The time the store opens on Saturday
SaturdayClose "SaturdayClose":  "6:00 PM"
The time the store closes on Saturday

Get Store

Gets a single store by Id

GET /api/v3/stores/2649 

HTTP/1.1 200 OK

 {
            "OID": 2649,
            "SiteID": 1,
            "Created": "2018-02-07T16:40:03.43Z",
            "Modified": "2018-02-07T16:40:03.43Z",
            "Status": "Active",
            "OnlineStatus": "Migrating",
            "OnlineDate": "2018-02-07T16:40:03.43Z",
            "Name": "East Coast Store 1",
            "UrlIdentifier": "Sample-Store",
            "StoreNumber": "1",
            "Address": "12005 Sunrise Valley Drive",
            "Address2": "Suite 400",
            "City": "Reston",
            "StateOrProvince": "VA",
            "PostalCode": "20191",
            "Country": "US",
            "Phone": "703-689-2121",
            "Hours": "9-8",
            "URL": "www",
            "Email": "",
            "OpenDate": "2015-05-25T07:00:00",        
            "IsBOPISEnabled": true,
            "IsSTSEnabled": false,
            "IsSFSEnabled": false,
            "BagFee": {
            "SKU": "890212345",
            "Fee": 1.34,
            "FeeType": "PerItem"
        },
            "Latitude": 38.932,
            "Longitude": -77.3386,
            "Description": "This is the main store on the east coast. It is in Virginia, so is Mount Vernon. It has clothes, accessories, and really friendly staff members. Stop by whenever you are in the area!",
            "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_2649_fs_default.jpg",
            "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_2649_th_default.jpg",
            "Badges": [
            "Just Opened"
        ],
            "Timezone": "",
            "SundayOpen": "",
            "SundayClose": "",
            "MondayOpen": "9:00 AM",
            "MondayClose": "6:00 PM",
            "TuesdayOpen": "9:00 AM",
            "TuesdayClose": "6:00 PM",
            "WednesdayOpen": "9:00 AM",
            "WednesdayClose": "6:00 PM",
            "ThursdayOpen": "9:00 AM",
            "ThursdayClose": "6:00 PM",
            "FridayOpen": "9:00 AM",
            "FridayClose": "6:00 PM",
            "SaturdayOpen": "",
            "SaturdayClose": ""
    }

List Stores

Retrieves a list of stores for a marketAgility site.

GET /api/v3/stores/ 

HTTP/1.1 200 OK
[
 {
            "OID": 2649,
            "SiteID": 1,
            "Created": "2018-02-07T16:40:03.43Z",
            "Modified": "2018-02-07T16:40:03.43Z",
            "Status": "Active",
            "OnlineStatus": "Migrating",
            "OnlineDate": "2018-02-07T16:40:03.43Z",
            "Name": "East Coast Store 1",
            "UrlIdentifier": "Sample-Store",
            "StoreNumber": "1",
            "Address": "12005 Sunrise Valley Drive",
            "Address2": "Suite 400",
            "City": "Reston",
            "StateOrProvince": "VA",
            "PostalCode": "20191",
            "Country": "US",
            "Phone": "703-689-2121",
            "Hours": "9-8",
            "URL": "www",
            "Email": "",
            "OpenDate": "2015-05-25T07:00:00Z",
            "IsBOPISEnabled": true,
            "IsSTSEnabled": false,
            "IsSFSEnabled": false,
            "BagFee": {
            "SKU": "890212345",
            "Fee": 1.34,
            "FeeType": "PerItem"
        },
            "Latitude": 38.932,
            "Longitude": -77.3386,
            "Description": "This is the main store on the east coast. It is in Virginia, so is Mount Vernon. It has clothes, accessories, and really friendly staff members. Stop by whenever you are in the area!",
            "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_2649_fs_default.jpg",
            "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_2649_th_default.jpg",
            "Badges": [
            "Just Opened"
        ],
            "Timezone": "",
            "SundayOpen": "",
            "SundayClose": "",
            "MondayOpen": "9:00 AM",
            "MondayClose": "6:00 PM",
            "TuesdayOpen": "9:00 AM",
            "TuesdayClose": "6:00 PM",
            "WednesdayOpen": "9:00 AM",
            "WednesdayClose": "6:00 PM",
            "ThursdayOpen": "9:00 AM",
            "ThursdayClose": "6:00 PM",
            "FridayOpen": "9:00 AM",
            "FridayClose": "6:00 PM",
            "SaturdayOpen": "",
            "SaturdayClose": ""
    }
]

Creates a new store

Create a store.

POST /api/v3/stores/ 
{
    "Name": "Reston Store",
    "StoreNumber": "1",
    "Address": "12005 Sunrise Valley Drive",
    "Address2": "Suite 400",
    "City": "Reston",
    "StateOrProvince": "VA",
    "PostalCode": "20191",
    "Country": "US",
    "Phone": "703-689-2121",
    "Badges": [
        "Just Opened"
    ]
}
                                

HTTP/1.1 201 Created
{
            "OID": 2649,
            "SiteID": 1,
            "Created": "2018-02-07T16:40:03.43Z",
            "Modified": "2018-02-07T16:40:03.43Z",
            "Status": "Active",
            "OnlineStatus": "Migrating",
            "OnlineDate": "2018-02-07T16:40:03.43Z",
            "Name": "East Coast Store 1",
            "UrlIdentifier": "Sample-Store",
            "StoreNumber": "1",
            "Address": "12005 Sunrise Valley Drive",
            "Address2": "Suite 400",
            "City": "Reston",
            "StateOrProvince": "VA",
            "PostalCode": "20191",
            "Country": "US",
            "Phone": "703-689-2121",
            "Hours": "9-8",
            "URL": "www",
            "Email": "",
            "OpenDate": "2015-05-25T07:00:00Z",
            "IsBOPISEnabled": true,
            "IsSTSEnabled": false,
            "IsSFSEnabled": false,
            "BagFee": {
            "SKU": "890212345",
            "Fee": 1.34,
            "FeeType": "PerItem"
    },
            "Latitude": 38.932,
            "Longitude": -77.3386,
            "Description": "This is the main store on the east coast. It is in Virginia, so is Mount Vernon. It has clothes, accessories, and really friendly staff members. Stop by whenever you are in the area!",
            "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_2649_fs_default.jpg",
            "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_2649_th_default.jpg",
            "Badges": [
            "Just Opened"
    ],
            "Timezone": "",
            "SundayOpen": "",
            "SundayClose": "",
            "MondayOpen": "9:00 AM",
            "MondayClose": "6:00 PM",
            "TuesdayOpen": "9:00 AM",
            "TuesdayClose": "6:00 PM",
            "WednesdayOpen": "9:00 AM",
            "WednesdayClose": "6:00 PM",
            "ThursdayOpen": "9:00 AM",
            "ThursdayClose": "6:00 PM",
            "FridayOpen": "9:00 AM",
            "FridayClose": "6:00 PM",
            "SaturdayOpen": "",
            "SaturdayClose": ""
}

Update Store

Update an existing store

PUT /api/v3/stores/2649 
{
    "SundayOpen": "",
    "SundayClose": "",
    "MondayOpen": "9:00 AM",
    "MondayClose": "6:00 PM",
    "TuesdayOpen": "9:00 AM",
    "TuesdayClose": "6:00 PM",
    "WednesdayOpen": "9:00 AM",
    "WednesdayClose": "6:00 PM",
    "ThursdayOpen": "9:00 AM",
    "ThursdayClose": "6:00 PM",
    "FridayOpen": "9:00 AM",
    "FridayClose": "6:00 PM",
    "SaturdayOpen": "",
    "SaturdayClose": ""
}
                                

HTTP/1.1 204 No Content

Holidays

A Holiday is a specific day where the open and close times of the store are different from the normally published times

What you can do with a Holiday:
Holiday Properties
Property Description
OID "OID":  42608
The marketAgility ID for a holiday
EffectiveDate "EffectiveDate":  "2016-04-03T00:00:00"
The date this holiday is in effect
OpenTime "OpenTime":  "6:00 AM"
The open time for this date
CloseTime "CloseTime":   "10:00 PM"
The closing time for this date

Get Holiday

Gets a single holiday.

GET /api/v3/stores/2649/holidays/42632 

HTTP/1.1 200 OK
{
            "OID": 42632,
            "EffectiveDate": "2016-04-03T00:00:00",
            "OpenTime": "6:00 AM",
            "CloseTime": "10:00 PM"
}

List Holidays

Lists all holidays for a store

GET /api/v3/stores/2649/holidays/ 

HTTP/1.1 200 OK
[
    {
            "OID": 42632,
            "EffectiveDate": "2016-04-03T00:00:00",
            "OpenTime": "6:00 AM",
            "CloseTime": "10:00 PM"
    }
]

Create Holiday

Create a holiday for a store.

POST /api/v3/stores/2649/holidays/ 
{
    "EffectiveDate": "2016-04-02T00:00:00",
    "OpenTime": "6:00 AM",
    "CloseTime": "10:00 PM"
}
                                

HTTP/1.1 201 Created
{
            "OID": 12321,
            "EffectiveDate": "2016-04-03T00:00:00",
            "OpenTime": "6:00 AM",
            "CloseTime": "10:00 PM"
}

Update Holiday

Update an existing store holiday

PUT /api/v3/stores/2649/holidays/42632 
{
    "EffectiveDate": "2016-04-02T00:00:00",
    "OpenTime": "6:00 AM",
    "CloseTime": "10:00 PM"
}

                                

HTTP/1.1 204 No Content

Assets

The different assets available for a store. These are most commonly images, but can be links to videos or other digital asset types

What you can do with an Asset:
Asset Properties
Property Description
OID "OID":  42608
The marketAgility ID for an asset
Name "Name":  "Back"
The name of the asset
AssetType "AssetType":  "Image"
Can be integer or text, and is one of "Image, Youtube, Video, Rotation, AssetLink"
PreviewImage "ThumbImage":  "https://mabaseline.blob.core.windows.net/..../1_42668_TH_BLEGRN_BACK.JPG"
The URL for the store's preview/thumnail image
PreviewImage "FullImage":  "https://mabaseline.blob.core.windows.net/..../1_42668_FS_BLEGRN_BACK.JPG"
The URL for the stores full-sized image

Get Assets

Get an asset for a store.

GET api/v3/stores/2649/assets/41317 

HTTP/1.1 200 OK
{
            "OID": 41317,
            "Name": "",
            "AssetType": "Image",
            "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_42668_SW_BLEGRN.JPG",
            "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_42668_TH_BLEGRN.JPG",
            "SortOrder": 0
}

List Assets

Get all assets for a store.

GET api/v3/stores/42668/assets 

HTTP/1.1 200 OK
[
    {
            "OID": 41317,
            "Name": "",
            "AssetType": "Image",
            "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_42668_SW_BLEGRN.JPG",
            "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_42668_TH_BLEGRN.JPG",
            "SortOrder": 0
    }
]

Create Assets

Create an asset for a store.

POST /api/v3/stores/2649/assets 
{
    "Name": "test22",
    "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_113324_ZM_Pink.png",
    "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_113324_ZM_Pink.png"
}
                            

HTTP/1.1 201 Created
{
            "OID": 41317,
            "Name": "",
            "AssetType": "Image",
            "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_42668_SW_BLEGRN.JPG",
            "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_42668_TH_BLEGRN.JPG",
            "SortOrder": 0
}

Update Assets

Update an existing store asset View

PUT /api/v3/stores/2649/assets/41317 
{
    "Name": "test22",
    "PreviewImage": "https://mabaseline.blob.core.windows.net/images/stores/1_113324_ZM_Pink.png",
    "FullImage": "https://mabaseline.blob.core.windows.net/images/stores/1_113324_ZM_Pink.png"
}

                                

HTTP/1.1 204 No Content