• Register

BOPS Product Availability (Using Product ID) V4

Description

The V4 BOPS (Buy Online Pick-up in Store) Product Availability service allows you specify a Product ID and return the products BOPS availability at a nearby store using zipcode, city-state, or locationnumber.

back to top

HTTP Method and Request URL

GET

https://api.macys.com/v4/catalog/bops/product/[ProductID](object(nestedobject))

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. Click here for a list of your API keys. 

Yes

xmj9js4jkdpe1983fmwu98gh

Path Parameters

Parameter

Description

Mandatory

Sample Value

productID

Unique ID for each product. Multiple productIDs can be sent in one call

optional, but you need at least upcNumber or productId.

 77589 or multiple with comma separator

Object Parameters

Object

 Nested Object

Description

Mandatory

 Sample Value
upcs upcdetails, storedata Returns UPC details No (upcs(upcdetails))
stores No (stores)

Query Parameters

Parameter

Description

Mandatory

Sample Value
locationNumber Location number of the area you are trying to locate a BOPS product No 5459
latitude latitude of area you are trying to locate a BOPS product. No 37.355965
longitude longitude of area you are trying to locate a BOPS product. No -122.01318
zipCode Zip code of area you are trying to locate a BOPS product. No 94105
city City code of area you are trying to locate a BOPS product. "state" parameter is needed if specifying the "city" parameter. No San Francisco
state City code of area you are trying to locate a BOPS product "city" parameter is needed ifspecifying the "state" parameter. No CA
distance Default is 200 (miles).  Can be a number between 1-200 No 50
numberOfStores Default is 15. Can be a number between 1-15 No 5
callback If sent, the format is JSONP (JSON with Padding) with the callback returned with the JSON response. You can put anything in the callback parameter and whatever you send is returned. No magicofmacysap

back to top

Sample Requests and Responses

Sample Requests

Request URL:

GET

https://api.macys.com/v4/catalog/bops/product/580858(upcs(upcdetails,storedata),stores)?city=San Francisco&state=CA&distance=100&numberOfStores=1

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept: application/json

Sample Response

{
    "prodId": 580858,
    "upcs": [{
        "upcNumber": 883049225296,
        "upcAvailability": [{
            "locationNumber": 5133,
            "storeAvailabilityStatus": "AVAILABLE",
            "bopsAvailabilityStatus": "NOT_AVAILABLE",
            "bopsEligibilityStatus": "ELIGIBLE"
        }]
    }],
    "stores": [{
        "storeId": 212,
        "storeNumber": 428,
        "locationNumber": 5133,
        "divisionId": "7",
        "name": "Macy's Union Square",
        "location": {
            "latitude": "37.7868326",
            "longitude": "-122.4074627"
        },
        "address": {
            "line1": "170 O'Farrell Street",
            "line2": "",
            "city": "San Francisco",
            "state": "CA",
            "countryCode": "USA ",
            "zipCode": "94102-2202"
        },
        "phone": "415-397-3333",
        "storeworkinghours": [{
            "storeoperationdate": "2014-03-28",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-03-29",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-03-30",
            "storeopenhour": "11:00",
            "storeclosehour": "19:00"
        }, {
            "storeoperationdate": "2014-03-31",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-01",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-02",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-03",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-04",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-05",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-06",
            "storeopenhour": "11:00",
            "storeclosehour": "19:00"
        }, {
            "storeoperationdate": "2014-04-07",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }, {
            "storeoperationdate": "2014-04-08",
            "storeopenhour": "10:00",
            "storeclosehour": "21:00"
        }],
        "units": "mi",
        "distance": 1.0499595172893268,
        "order": "0",
        "attributes": [{
            "attributeName": "BOPS_NPD",
            "attributeValue": "25-DEC-14"
        }, {
            "attributeName": "SL_MATERNITY",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "BOPS_STORE_OPEN_BUFFER",
            "attributeValue": "01:00"
        }, {
            "attributeName": "SL_SHOPPER",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "BOPS_STORE_PHONE",
            "attributeValue": "8002896229"
        }, {
            "attributeName": "STORE_REGION_LOCATION",
            "attributeValue": "United States"
        }, {
            "attributeName": "SL_VISITOR",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "SL_RESTAURANT",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "TIMEZONE",
            "attributeValue": "PST"
        }, {
            "attributeName": "LATITUDE",
            "attributeValue": "37.7868326"
        }, {
            "attributeName": "BOPS_PICKUP_INSTRUCTIONS",
            "attributeValue": "*"
        }, {
            "attributeName": "DAYLIGHT_SAVINGS_INDICATOR",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "SL_BRIDAL",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "STORE_TYPE_DESC",
            "attributeValue": "FUL"
        }, {
            "attributeName": "SL_FURNITURE",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "STORE_LISTING_ENABLED",
            "attributeValue": "FALSE"
        }, {
            "attributeName": "SL_MATTRESS",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "BOPS_PICKUP_CUTOFF",
            "attributeValue": "02:00"
        }, {
            "attributeName": "BOPS_SLA_HOURS",
            "attributeValue": "4"
        }, {
            "attributeName": "SL_THISIT",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "LONGITUDE",
            "attributeValue": "-122.4074627"
        }, {
            "attributeName": "SL_DESIGN",
            "attributeValue": "TRUE"
        }, {
            "attributeName": "GMT_OFFSET",
            "attributeValue": "-8"
        }, {
            "attributeName": "BOPS_ELIGIBILITY",
            "attributeValue": "FALSE"
        }, {
            "attributeName": "HAS_EVENTS",
            "attributeValue": "TRUE"
        }]
    }]
}

back to top

 

cURL Example

curl -X GET -H "x-macys-webservice-client-id: xxxxxxxxxx" -H "Accept: application/json" "https://api.macys.com/v4/catalog/bops/product/580858(upcs(upcdetails,storedata),stores)?city=San Francisco&state=CA&distance=100&numberOfStores=1"

 

 

Error Codes

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

back to top

version 5 as of 8 years ago by Unknown

Docs Navigation