App Config V2

Description

This document covers the basic API information for retrieving the configuration files for mobile for a specific mobile app. A separate API key is required for each mobile application. The current applications supported are:

macys iphone

macys android

back to top

HTTP Method and Request URL

GET

https://api.macys.com/v2/utility/mobileapp

 

back to top

Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

Accept

Specifies the output format. Can be application/json or application/xml.

Yes

application/json

application/xml

x-macys-webservice-client-id

Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys.

Yes

xmj9js4jkdpe1983fmwu98gh

back to top

Sample Requests and Responses

Sample Request

Request URL:

GET

https://api.macys.com/v2/utility/mobileapp

HTTP Headers:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept:application/json

Sample Response

{
    "configVersion": "1361663",
    "appVersionInfo": {
        "appVersionNumber": "1.1",
        "appStoreLink": "http://itunes.apple.com/us/app/macys-ishop/id341036067?mt=8",
        "supportedVersions": [
            "1.0",
            "1.1"
        ]
    },
    "appLayout": [
          "offers",
          "shop",
        "stores",
        "registry",
        "settings",
        "myAccount",
        "bag",
        "messages",
        "billpay"
    ],
    "appConfig": {
         "shop": {
            "appDisplayName": "Shop",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/shop_icon.png",
            "featureLayout": [
                "search",
                "categories",
                "checkout",
                "bag"
            ]
        },
        "offers": {
            "appDisplayName": "Offers",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/offer_icon.png",
            "featureLayout": [
                "offers"
            ]
        },
        "registry": {
            "appDisplayName": "Registry",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/registry_icon.png",
            "featureLayout": [
                "registry"
            ]
        },
        "messages": {
            "appDisplayName": "Messages",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/messages_icon.png",
            "featureLayout": [
                "messages"
            ]
        },
        "stores": {
            "appDisplayName": "Stores",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/stores_icon.png",
            "featureLayout": [
                "stores"
            ]
        },
        "myAccount": {
            "appDisplayName": "My Account",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/account_icon.png",
            "featureLayout": [
                "myAccount"
            ]
        },
        "settings": {
            "appDisplayName": "Settings",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/setting_icon.png",
            "featureLayout": [
                "settings"
            ]
        },
        "scan": {
            "appDisplayName": "Scan",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/scan-icon.png",
            "featureLayout": [
                "scan"
            ]
        },
        "bag": {
            "appDisplayName": "My Bag",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/bag_icon.png",
            "featureLayout": [
                "bag"
            ]
        },
        "billpay": {
            "appDisplayName": "Billpay",
            "appIcon": "http://220.227.31.122/appinapp/Bloomies/assets/billpay.png",
            "featureLayout": [
                "billpay"
            ]
        }
    },
    "featureConfig": {
        "shop": {
            "pageTitle": "shop",
            "defaultTab": "http://220.227.31.122/asset/home.png",
            "highlightedTab": "http://220.227.31.122/asset/home_selected.png",
            "landingUrl": "http://www1.getmoov.bloomingdales.com/catalog/index.ognc?CategoryID=2910&MVwomen=1&PageID=12500576922458",
        "coremetricsPageTag": "mobile.shop.landing",
        "urlPatternMatch": "/shop/index.ognc"
        },
        "scan": {
            "pageTitle": "scan",
            "defaultTab": "http://220.227.31.122/asset/mybag.png",
            "highlightedTab": "http://220.227.31.122/asset/home_selected.png",
            "landingUrl": "ishop://scan",
            "coremetricsPageTag": "mobile.scan.landing",
        "urlPatternMatch": "ishop://scan"
        },
        "registry": {
            "pageTitle": "registry",
            "defaultTab": "http://220.227.31.122/asset/mybag.png",
            "highlightedTab": "http://220.227.31.122/asset/home_selected.png",
            "landingUrl": "https://www.getmoov.bloomingdales.com/registry/wedding/registrysignin",
        "coremetricsPageTag": "",
        "urlPatternMatch": "registry/wedding"
        },
        "categories": {
            "pageTitle": "shop",
            "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/categories.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/categories_hover.png",
            "landingUrl": "http://www1.getmoov.bloomingdales.com/",
        "coremetricsPageTag": "",
        "urlPatternMatch": "TBD"
        },
        "offers": {
            "pageTitle": "offers"
        "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/checkout.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/checkout_hover.png",
            "landingUrl":"http://www1.getmoov.bloomingdales.com/",
        "coremetricsPageTag": "",
        "urlPatternMatch": "TBD"
        },
        "checkout": {
            "pageTitle": "checkout",
            "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/checkout.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/checkout_hover.png",
            "landingUrl":"http://www1.bloomingdales.getmoov.com/",
        "coremetricsPageTag": "",
        "urlPatternMatch": "TBD"
        },
        "bag": {
            "pageTitle": "my bag",
            "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/mybag.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/mybag_hover.png",
            "landingUrl":"http://www1.bloomingdales.getmoov.com/bag/index.ognc",
        "coremetricsPageTag": "",
        "urlPatternMatch": "/bag/index.ognc"
        },
        "search": {
            "pageTitle": "search",
            "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/search.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/search_hover.png",
            "landingUrl":"ishop://search",
        "coremetricsPageTag": "",
        "urlPatternMatch": "ishop://search"
        },
    "stores": {
            "pageTitle": "stores",
            "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/mybag.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/mybag_hover.png",
            "landingUrl":"http://www1.bloomingdales.getmoov.com/store/index.ognc",
        "coremetricsPageTag": "",
        "urlPatternMatch": "/store/index.ognc"
        },
    "myAccount": {
            "pageTitle": "myAccount",
            "defaultTab": "http://220.227.31.122/appinapp/Bloomies/assets/account.png",
            "highlightedTab": "http://220.227.31.122/appinapp/Bloomies/assets/account_hover.png",
            "landingUrl":"https://www.getmoov.macys.com/myinfo/index.ognc",
        "coremetricsPageTag": "",
        "urlPatternMatch": "/myinfo/index.ognc"
        }
    },
    "extraAssets": {
        "appNavImage":"http://220.227.31.122/appinapp/Bloomies/assets/bloomingdales_text.png",
        "appNavBGImage":"http://220.227.31.122/appinapp/Bloomies/assets/navbar_bg.png",
        "homeContentBGImage":"http://220.227.31.122/appinapp/Bloomies/assets/image.png",
        "appIcon":"http://220.227.31.122/appinapp/bcom/asset/b_logo.png",
    },
    "serviceEndPoints": {
        "signin": "https://services2.macys.com/signin/",
        "coremetricsUrl": "http://Testdata.coremetrics.com/eluminate?ci=60067660&vn2=e4.0&st=1209682762203&vn1=4.1.8&ec=UTF-8",
        "scan": "TBD",
        "coupons": "TBD",
        "mobilelogs": "TBD"
    },
    "webServletEndPoints": {
      "search": "http://www1.getmoov.bloomingdales.com/search/index.ognc?moov_passthrough_type=moov_form_action&SearchTarget=*&KEYWORD_GO_BUTTON=KEYWORD_GO_BUTTON&Keyword=",
      "addToBag": "TBD"
    },
    "urlInterception": {
        "singleSignIn": [
            "/signin/index.ognc"
        ],
        "forcedSignOn": [
            "/checkout/",
            "/billbay/"
        ]
    },
    "poorNetwork":{
         "poorWifiMaxSecsLatency": 5,
         "poorNonWifiMaxSecsLatency": 10,
         "networkTimeIntervalCheck": 300
    },
    "loggingInfo": {
        "logLevel": "ERROR|INFO|DEBUG|WARN",
        "localEnabled": "TRUE",
        "remoteEnabled": "FALSE",
      "maxLogCount": "100"
    },
    "errorMessages": {
      "poorNetworkError": "TDB",
      "noNetworkError": "TDB",
        "configFileError": "TBD"
    }
}

 

back to top

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

Docs Navigation