Shelf Metrics & Analytics API (0.10.28)

Getting Started

Introduction:

The Stores Open API provides insights into integration points within the store domain. These Restful APIs helps clients to pull physical store layout, modular & product placements (planogram) and allows external entities to post data elements (realogram) aiming to automate work in certain areas within the store. This data is used to build systems that capitalizes on automation capabilities to prove or disprove its value and feasibility within the store environment.

Use Cases:

These APIs are primarily meant for companies who are interested in validating their technology products on the Walmart Store data set. These technology products include (but not limited to) robotic & imaging systems, computer vision applications, automation systems. The idea is that these system run within our store environment and can provide one or all the below data streams :

  • Report Shelf Gap detection for missing Items for both horizontal & vertical facings.
  • Item Barcode & Price detection.
  • Missing or Extra assortment.
  • Products (Actual/Plugged) detection.
  • Shelf Depth information.
  • UPCs on the shelf.

Next Steps:

  • If you’d like to get completely set up to make full use of the API, take a look at the Account section.
  • If you want the deep technical details, take a look at the API routes under Services.

Account

User accounts for this API consist of a unique client Id and client secret and are generated on request by end-users by contacting our team directly. Feel free to email us or Open Chat if you want to get access and start working with the data. Please identify your mail with the subject Request - API Credentials.

We reserve the right to grant permissions and decide which accounts are created. However, if you want to improve your chances please add on your email some information about you and your motivation and possible usages. We suggest providing the following information:

  • Full name.
  • Corporation/Company.
  • Area/Team (if any).
  • Motivation.
  • Expected usage (objectives and approximated workload).
  • Required stores.
  • Contact

Permissions

It is worth noting that not all accounts may have access to all endpoints on this API given the confidentiality of the information. If you run into an invalid access level problem and believe the data should be available to you, please contact us.

Authentication/Authorization

  • All out APIs are secured using OAoth2.0 specifications. You can refer the specifications here at : https://tools.ietf.org/html/rfc6749.
  • We support clientCredentials flow and you will need to use the credentials provided by our team to generate Bearer Authorization token and then use this Authorization token to make GET/POST requests.

    Store Planogram Gzip

    Get a store planogram gzip

    GET/store/{storeNbr}/planogram.gz

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    Query Parameters
    • type: required (string)

      restrict items in planogram to be of type "assigned", "unassigned", or "all"

      Example:

      assigned

    Response

    Returns a gziped json of the store planogram.

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Store Planogram

    Get a store planogram

    GET/store/{storeNbr}/planogram

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    Query Parameters
    • type: required (string)

      restrict items in planogram to be of type "assigned", "unassigned", or "all"

      Example:

      assigned

    Response

    View Sample Body

    Media type: application/json

    Properties:

    • /^[A-Z]$/: required (object)

      zone

      • /^[1-9][0-9]{0,2}$/: required (object)

        aisle

        • /^[1-9][0-9]?$/: required (array of items)

          section

          • deptNbr: required (integer - minimum: 1 - maximum: 99)
          • catgNbr: required (integer - minimum: 1)
          • catgDesc: required (string)
          • modSect: required (integer - minimum: 1)
          • locationId: required (integer - minimum: 1)
          • upc: required (string - pattern: ^[0-9]{11,12}$)
          • itemNbr: required (string - pattern: ^[0-9]{4,12}$)
          • itemDesc: required (string)
          • price: required (number - minimum: 0.01)
          • horizontalFacings: required (integer)
          • verticalFacings: required (integer)
          • capacity: required (integer)
          • notch: required (integer - minimum: 1 - maximum: 80)
          • productHeight: required (number)
          • productWidth: required (number)
          • productDepth: required (number)
          • xCoord: required (number)
          • expireDate: required (date-only | nil)
          • relayDate: required (date-only)
          • primeItemNbr: required (string - pattern: ^[0-9]{4,12}$)
          • coordinates: required (array of number)
          • name: required (string)
          • imageURL: required (string)
          • modPlanId: required (integer)
          • yCoord: required (number)
          • pluNumber: (integer)
          • fullCatgDesc: (array of items)
          • itemId: (string - pattern: ^[0-9]{4,12}$)
          • zone: (string - pattern: ^[A-Z]$)
          • aisle: (integer - minimum: 1 - maximum: 999)
          • section: (integer - minimum: 1 - maximum: 99)
          • upc_status: (Internal.UPCStatus)

          Example:

          { "expireDate": null, "relayDate": "2017-03-13", "deptNbr": 95, "modPlanId": 9008960, "catgNbr": 177, "modSect": 2, "locationId": 8, "upc": "022592334158", "primeItemNbr": "9576662", "itemNbr": "9576662", "itemDesc": "OZ 3L SPRING", "catgDesc": "JUG AND COMBO WATER", "price": 1, "horizontalFacings": 2, "verticalFacings": 1, "capacity": 14, "notch": 7, "productHeight": 9.6, "productWidth": 5.7, "productDepth": 5.7, "xCoord": 178.36, "yCoord": 14, "pluNumber": 22592334150, "fullCatgDesc": [ "Food & Beverages" ], "name": "OZARKA Brand 100% Natural Spring Water, 101.4-ounce plastic jug", "imageURL": "https://i5.walmartimages.com/asr/8f4af2d8-214d-49f7-8614-e8af1153efa3_1.7023e4df1489cbe897550f1b5df57817.jpeg", "itemId": "24389350", "coordinates": [ 7437.73, 1604.21 ], "zone": "A", "aisle": 24, "section": 6, "upc_status": null
          }
        • sections: required (integer - minimum: 1 - maximum: 99)
    • /^[1-9][0-9]?$/: required (object)

      department

      • /^[1-9][0-9]{0,3}$/: required (object)

        category

        • /^[1-9][0-9]{0,3}$/: required (array of items)

          modular section

          • deptNbr: required (integer - minimum: 1 - maximum: 99)
          • catgNbr: required (integer - minimum: 1)
          • catgDesc: required (string)
          • modSect: required (integer - minimum: 1)
          • locationId: required (integer - minimum: 1)
          • upc: required (string - pattern: ^[0-9]{11,12}$)
          • itemNbr: required (string - pattern: ^[0-9]{4,12}$)
          • itemDesc: required (string)
          • price: required (number - minimum: 0.01)
          • horizontalFacings: required (integer)
          • verticalFacings: required (integer)
          • capacity: required (integer)
          • notch: required (integer - minimum: 1 - maximum: 80)
          • productHeight: required (number)
          • productWidth: required (number)
          • productDepth: required (number)
          • xCoord: required (number)
          • expireDate: required (date-only | nil)
          • relayDate: required (date-only)
          • primeItemNbr: required (string - pattern: ^[0-9]{4,12}$)
          • coordinates: required (array of number)
          • name: required (string)
          • imageURL: required (string)
          • modPlanId: required (integer)
          • yCoord: required (number)
          • pluNumber: (integer)
          • fullCatgDesc: (array of items)
          • itemId: (string - pattern: ^[0-9]{4,12}$)
          • zone: (string - pattern: ^[A-Z]$)
          • aisle: (integer - minimum: 1 - maximum: 999)
          • section: (integer - minimum: 1 - maximum: 99)
          • upc_status: (Internal.UPCStatus)

          Example:

          { "expireDate": null, "relayDate": "2017-03-13", "deptNbr": 95, "modPlanId": 9008960, "catgNbr": 177, "modSect": 2, "locationId": 8, "upc": "022592334158", "primeItemNbr": "9576662", "itemNbr": "9576662", "itemDesc": "OZ 3L SPRING", "catgDesc": "JUG AND COMBO WATER", "price": 1, "horizontalFacings": 2, "verticalFacings": 1, "capacity": 14, "notch": 7, "productHeight": 9.6, "productWidth": 5.7, "productDepth": 5.7, "xCoord": 178.36, "yCoord": 14, "pluNumber": 22592334150, "fullCatgDesc": [ "Food & Beverages" ], "name": "OZARKA Brand 100% Natural Spring Water, 101.4-ounce plastic jug", "imageURL": "https://i5.walmartimages.com/asr/8f4af2d8-214d-49f7-8614-e8af1153efa3_1.7023e4df1489cbe897550f1b5df57817.jpeg", "itemId": "24389350", "coordinates": [ 7437.73, 1604.21 ], "zone": "A", "aisle": 24, "section": 6, "upc_status": null
          }

    Example:

    { "A": { "1": { "1": [ { "capacity": 1, "catgDesc": "pizza", "catgNbr": 1, "coordinates": [ 1.11, 2.22 ], "deptNbr": 1, "modPlanId": 10003605, "expireDate": "2017-04-08", "horizontalFacings": 1, "imageURL": "https://image.example.com/12345.jpg", "itemDesc": "frozen pep pzza", "itemNbr": "1234567890", "locationId": 1, "modSect": 1, "name": "frozen pepperoni pizza", "notch": 1, "price": 199.99, "primeItemNbr": "1234567890", "productDepth": 3.33, "productHeight": 1.11, "productWidth": 2.22, "relayDate": "2017-04-08", "upc": "123456789012", "verticalFacings": 1, "xCoord": 5.55, "yCoord": 69.66 } ], "sections": 1 } }
    }

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Department Planogram

    Get all items in a department

    GET/store/{storeNbr}/planogram/department/{deptNbr}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • deptNbr: required (integer - minimum: 1 - maximum: 99)

      Example:

      1
    Query Parameters
    • type: required (string - pattern: ^(assigned|unassigned|all)$)

      restrict items in planogram to be of type "assigned", "unassigned", or "all"

      Example:

      all

    Response

    Ok

    View Sample Body

    Media type: application/json

    Type:

    [object Object]

    Example:

    { "A": { "1": { "sections": 1, "1": [ { "deptNbr": 1, "modPlanId": 10003605, "catgNbr": 1, "catgDesc": "food", "modSect": 1, "locationId": 1, "upc": "12345678901", "itemNbr": "1234", "itemDesc": "food", "price": 1.00, "horizontalFacings": 1, "verticalFacings": 1, "capacity": 10, "notch": 11, "productHeight": 110, "productWidth": 111, "productDepth": 101, "xCoord": 100, "expireDate": "2001-01-01", "relayDate": "2000-01-01", "primeItemNbr": "1234567890", "coordinates": [ 8720.27, 3943.6 ], "name": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "imageURL": "http://i5.walmartimages.com/asr/c3587639-6239-426a-8226-3f05de1607ea_1.bab1b661cb8b598fab3d7911041e6e29.jpeg", "yCoord": 69.66 } ] } }
    }
    

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Department Items

    Get all items in a department

    GET/store/{storeNbr}/planogram/department/{deptNbr}/meta

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • deptNbr: required (integer - minimum: 1 - maximum: 99)

      Example:

      1

    Response

    Ok

    View Sample Body

    Media type: application/json

    Properties:

    • /^[A-Z]$/: required (object)
      • /^[1-9][0-9]{0,2}$/: required (object)
        • /^[1-9][0-9]?$/: required (array of integer)

    Example:

    { "A": { "1": { "1": [1,2,3,4,5] } }
    }
    

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Section Planogram

    Get a section planogram

    GET/store/{storeNbr}/planogram/{zone}/{aisle}/{section}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string)
    • aisle: required (integer)
    • section: required (integer)

    Response

    Ok

    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • deptNbr: required (integer - minimum: 1 - maximum: 99)
    • catgNbr: required (integer - minimum: 1)
    • catgDesc: required (string)
    • modSect: required (integer - minimum: 1)
    • locationId: required (integer - minimum: 1)
    • upc: required (string - pattern: ^[0-9]{11,12}$)
    • itemNbr: required (string - pattern: ^[0-9]{4,12}$)
    • itemDesc: required (string)
    • price: required (number - minimum: 0.01)
    • horizontalFacings: required (integer)
    • verticalFacings: required (integer)
    • capacity: required (integer)
    • notch: required (integer - minimum: 1 - maximum: 80)
    • productHeight: required (number)
    • productWidth: required (number)
    • productDepth: required (number)
    • xCoord: required (number)
    • expireDate: required (date-only | nil)
    • relayDate: required (date-only)
    • primeItemNbr: required (string - pattern: ^[0-9]{4,12}$)
    • coordinates: required (array of number)
    • name: required (string)
    • imageURL: required (string)
    • modPlanId: required (integer)
    • yCoord: required (number)
    • pluNumber: (integer)
    • fullCatgDesc: (array of items)
    • itemId: (string - pattern: ^[0-9]{4,12}$)
    • zone: (string - pattern: ^[A-Z]$)
    • aisle: (integer - minimum: 1 - maximum: 999)
    • section: (integer - minimum: 1 - maximum: 99)
    • upc_status: (Internal.UPCStatus)

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Request Session

    Request a session for a scanning device to scan a store

    GET/store/{storeNbr}/session/type/{method}/schedule/{schedule}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • method: required (realogram)

      The api method that will be used to send data

    • schedule: required (one of scan1, scan2, gm, test, demo, other, audit)
    Query Parameters
    • production: (boolean)

      Whether data source is from a scheduled production run

    • depts: (array of )

      List of departments that are part of the requested session

    Response

    View Sample Body

    Media type: application/json

    Properties:

    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    • name: required (one of scan1, scan2, gm, test, demo, other)

      scheduled scan name

    • start: required (time-only)

      scheduled start in local time

    • end: required (time-only)

      scheduled end in local time

    • departments: (array of items)
      • deptNbr: required (integer - minimum: 1 - maximum: 99)
      • deptDesc: required (string)
    • aisles: required (array of items)
      • zone: required (string - pattern: ^[A-Z]$)
      • aisle: required (integer - minimum: 1 - maximum: 999)
      • section: required (integer - minimum: 1 - maximum: 99)

    Example:

    { "session": "adcf67c8a78aa95a10765eaf6178aca4", "name": "scan1", "start": "21:14:32", "end": "21:16:02", "aisles": [ { "zone": "A", "aisle": 1, "section": 1 } ], "departments": [ { "deptNbr": 1, "deptDesc": "CANDY AND TOBACCO" } ]
    }
    

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Additional concurrent sessions cannot be granted.

    View Sample Body

    Media type: application/json

    Properties:

    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    • name: required (one of scan1, scan2, gm, test, demo, other)

      scheduled scan name

    • start: required (time-only)

      scheduled start in local time

    • end: required (time-only)

      scheduled end in local time

    • departments: (array of items)
      • deptNbr: required (integer - minimum: 1 - maximum: 99)
      • deptDesc: required (string)
    • aisles: required (array of items)
      • zone: required (string - pattern: ^[A-Z]$)
      • aisle: required (integer - minimum: 1 - maximum: 999)
      • section: required (integer - minimum: 1 - maximum: 99)

    Example:

    { "session": "adcf67c8a78aa95a10765eaf6178aca4", "name": "scan1", "start": "21:14:32", "end": "21:16:02", "aisles": [ { "zone": "A", "aisle": 1, "section": 1 } ], "departments": [ { "deptNbr": 1, "deptDesc": "CANDY AND TOBACCO" } ]
    }
    

    Internal Server Error

    Service Unavailable

    Close Session

    Close a session. This indicates that a scanning device has physically finished scanning; data is still allowed to be sent after the session is closed.

    POST/store/{storeNbr}/session/{session}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Properties:

    • newDepts: (array of items)

      List of departments worked on for the session.

      Example:

      [ 1, 2, 3
      ]

    Response

    The session was successfully closed.

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    The session has been previously closed.

    Internal Server Error

    Service Unavailable

    Realogram

    Send aisle scan data to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Properties:

    • /^[1-9][0-9]?$/: required (type)
      • timestamp: required (datetime)
      • products: (array of items)
        • id: required (object)
          • type: required (item)
          • value: required (string - pattern: ^[0-9]{5,12}$)
        • type: required (string - pattern: \b(?:facing|gap)\b)

        Example:

        { "origin": { "x": 123, "y": 321, "z": 38 }, "height": 12, "width": 10, "id": { "type": "item", "value": "1234567" }, "type": "gap"
        }
      • labels: (array of items)
        • data: required (object)
          • id: required (object)
            • type: required (item)
            • value: required (string - pattern: ^[0-9]{5,12}$)
          • price: (number)

        Example:

        { "origin": { "x": 123, "y": 321, "z": 27 }, "height": 12, "width": 10, "data": { "id": { "type": "item", "value": "1234567" }, "price": 12.99 }
        }
      • topStock: (array of items)
        • id: required (object)
          • type: required (upc)
          • value: required (string - pattern: ^[0,1,3,6-9][0-9]{11}$)

            This is a product upc which should not contain a prefix of 2 (variable weight product),4(store use barcode) or 5(store coupon barcode)

        Example:

        { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" }
        }
      • exceptions: (array of items)
        • origin: required (object)

          Coordinates of lower left corner of object (1unit ~= 1mm). Reference frame is panoramic stiched image.

          • x: required (number)
          • y: required (number)
          • z: (number)
        • height: required (number)

          height of scan in mm

        • width: required (number)

          width of scan in mm

        • type: required (string - pattern: \b(?:pole|clip strip|obstruction)\b)

        Example:

        { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "pole"
        }
      • origin: required (object)

        Coordinates of lower left corner of object (1unit ~= 1mm). Reference frame is panoramic stiched image.

        • x: required (number - minimum: 0)
        • y: required (number - minimum: 0)
        • z: (number - minimum: 0)
      • height: required (number)

        height of scan in mm, value should be positive

      • width: required (number)

        width of scan in mm, value should be positive

      Example:

      { "origin": { "x": 123, "y": 321, "z": 12 }, "height": 12, "width": 10, "timestamp": "2017-06-23T21:02:33+00:00", "products": [ { "origin": { "x": 123, "y": 321, "z": 38 }, "height": 12, "width": 10, "id": { "type": "item", "value": "1234567" }, "type": "facing" }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "item", "value": "1234568" }, "type": "gap" } ], "labels": [ { "origin": { "x": 123, "y": 321, "z": 27 }, "height": 12, "width": 10, "data": { "id": { "type": "item", "value": "1234567" }, "price": 12.99 } } ], "topStock": [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" } }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" } } ], "exceptions": [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "pole" }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "obstruction" } ]
      }

    Example:

    { "1": { "timestamp": "2017-06-23T21:02:33+00:00", "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "labels": [ { "origin": { "x": 123, "y": 321, "z": 27 }, "height": 12, "width": 10, "data": { "id": { "type": "item", "value": "1234567" }, "price": 12.99 } } ], "products": [ { "origin": { "x": 123, "y": 321, "z": 38 }, "height": 12, "width": 10, "id": { "type": "item", "value": "1234567" }, "type": "facing" }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "item", "value": "1234568" }, "type": "gap" } ], "topStock": [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" } }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" } } ], "exceptions": [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "pole" }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "obstruction" } ] }
    }
    

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Products Realogram

    Send aisle products to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/products

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • id: required (object)
      • type: required (item)
      • value: required (string - pattern: ^[0-9]{5,12}$)
    • type: required (string - pattern: \b(?:facing|gap)\b)

    Example:

    { "origin": { "x": 123, "y": 321, "z": 38 }, "height": 12, "width": 10, "id": { "type": "item", "value": "1234567" }, "type": "gap"
    }

    Example:

    [ { "origin": { "x": 123, "y": 321, "z": 38 }, "height": 12, "width": 10, "type": "facing", "id": { "type": "item", "value": "1234567" } }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "gap", "id": { "type": "item", "value": "1234568" } }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Labels Realogram

    Send aisle labels to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/labels

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • data: required (object)
      • id: required (object)
        • type: required (item)
        • value: required (string - pattern: ^[0-9]{5,12}$)
      • price: (number)

    Example:

    { "origin": { "x": 123, "y": 321, "z": 27 }, "height": 12, "width": 10, "data": { "id": { "type": "item", "value": "1234567" }, "price": 12.99 }
    }

    Example:

    [ { "origin": { "x": 123, "y": 321, "z": 27 }, "height": 12, "width": 10, "data": { "id": { "type": "item", "value": "1234567" }, "price": 12.99 } }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Topstock Realogram

    Send aisle topStock to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/topStock

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • id: required (object)
      • type: required (upc)
      • value: required (string - pattern: ^[0,1,3,6-9][0-9]{11}$)

        This is a product upc which should not contain a prefix of 2 (variable weight product),4(store use barcode) or 5(store coupon barcode)

    Example:

    { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" }
    }

    Example:

    [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" } }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "upc", "value": "123456789012" } }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Section Breaks Realogram

    Send aisle section breaks to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/sectionBreaks

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • origin: required (object)

      Coordinates of lower left corner of object (1unit ~= 1mm). Reference frame is panoramic stiched image.

      • x: required (number - minimum: 0)
      • y: (number - minimum: 0)
      • z: (number - minimum: 0)
    • height: (number - minimum: 0)

      height of scan in mm

    • width: (number - minimum: 0)

      width of scan in mm

    Example:

    { "origin": { "x": 123 }, "height": 12, "width": 10
    }

    Example:

    [ { "origin": { "x": 123 }, "height": 12, "width": 10 }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Section Labels Realogram

    Send aisle section labels to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/sectionLabels

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • id: required (object)
      • type: required (section)
      • value: required (string - pattern: ^[0-9]{0,10}$)

    Example:

    { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "section", "value": "123456" }
    }

    Example:

    [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "id": { "type": "section", "value": "123456" } }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Aisle Exceptions Realogram

    Send aisle exceptions to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/exceptions

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • origin: required (object)

      Coordinates of lower left corner of object (1unit ~= 1mm). Reference frame is panoramic stiched image.

      • x: required (number)
      • y: required (number)
      • z: (number)
    • height: required (number)

      height of scan in mm

    • width: required (number)

      width of scan in mm

    • type: required (string - pattern: \b(?:pole|clip strip|obstruction)\b)

    Example:

    { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "pole"
    }

    Example:

    [ { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "pole" }, { "origin": { "x": 123, "y": 321 }, "height": 12, "width": 10, "type": "obstruction" }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Notifications

    Alias for /notification/stream for backwards compatibility

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/notification

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    Annotations
    • deprecated: ()
    View Sample Body

    Media type: application/json

    Properties:

    • start: required (datetime)
    • end: required (datetime)
    • panoURL: required (array of string)

      urls for pano image

    Example:

    { "start": "2017-06-23T21:02:33+00:00", "end": "2017-06-23T21:02:33+00:00", "panoURL": [ "https://example.com/pano.jpg" ]
    }

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Stream Realogram

    Send aisle scan data to be processed.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/notification/stream

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Properties:

    • start: required (datetime)
    • end: required (datetime)
    • panoURL: required (array of string)

      urls for pano image

    Example:

    { "start": "2017-06-23T21:02:33+00:00", "end": "2017-06-23T21:02:33+00:00", "panoURL": [ "https://example.com/pano.jpg" ]
    }

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Aggregate Realogram

    Notify the completion of aggregated aisle data transer.

    POST/store/{storeNbr}/realogram/aisle/{zone}-{aisle}/session/{session}/notification/aggregate

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • zone: required (string - pattern: ^[A-Z]$)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      5
    • session: required (string - pattern: ^[a-fA-F0-9]{32}$)

      md5 sum that uniquely identifies scanning a session

      Example:

      adcf67c8a78aa95a10765eaf6178aca4
    View Sample Body

    Media type: application/json

    Properties:

    • start: required (datetime)
    • end: required (datetime)
    • panoURL: required (string)

      urls for pano image

    • structured: (boolean)

      optional parameter that defaults to false

    Example:

    { "start": "2017-06-23T21:02:33+00:00", "end": "2017-06-23T21:02:33+00:00", "panoURL": "https://example.com/pano.jpg"
    }

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Sort Zones

    A map of sort-zones to upc's

    GET/store/{storeNbr}/receiving/sort-zones

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260

    Response

    View Sample Body

    Media type: application/json

    Properties:

    • /^\d+$/: required (array of items)

      sort zone

    Example:

    { "1": [ "123", "1234", "123456", "123456789015" ], "2": [ "12345678901", "1234567890", "123456789", "12345678" ]
    }

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Sort Zones Map

    A map of sort-zones to upc's

    GET/store/{storeNbr}/receiving/sort-zones/config

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260

    Response

    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • zone: required (string - pattern: ^[A-Z]$)
    • aisle: required (integer - minimum: 1 - maximum: 99)
    • sortZone: required (integer - minimum: 1 - maximum: 99)

    Example:

    [ { "zone": "A", "aisle": 1, "sortZone": 1 }, { "zone": "A", "aisle": 2, "sortZone": 1 }, { "zone": "A", "aisle": 3, "sortZone": 1 }, { "zone": "B", "aisle": 1, "sortZone": 2 }, { "zone": "C", "aisle": 1, "sortZone": 3 }
    ]

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Received Packages

    Data for packages received off of a dc delivery truck

    POST/store/{storeNbr}/receiving/packages

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • lpn: required (string - pattern: ^([a-zA-Z0-9]{16,26}|NOT_FOUND|OTHER_BARCODE|INVALID_BARCODE|MULTIPLE_BARCODES|NO_READ|MULTIPACK|BREAKPACK)$)
    • barcodes: required (array of items)
    • scanTime: required (datetime)
    • sortConfirmedTime: (datetime | nil)
    • jam: required (boolean | nil)
    • laneFull: required (boolean | nil)
    • out: required (boolean | nil)
    • trailer: required (integer | nil)
    • dept: required (integer | nil)
    • item: required (string - pattern: ^$|^0$|^[0-9]{4,12}$)
    • zone: required (string - pattern: ^$|^[A-Z]$)
    • lane: required (integer | nil)
    • sortConfirmedLane: required (integer | nil)
    • sortResult: required (one of ERROR_FINDING_SORTLANE, FILE_INFORMATION_MISSING, INVALID_BARCODE, MULTIPLE_BARCODES, NO_ROUTE, NO_READ, OTHER_BARCODE, SORTED, MULTI_ITEM, BREAKPACK)
    • status: required (one of INCOMPLETE, MULTIPLE_BARCODES, NOT_FOUND, NO_READ, UNKNOWN, OK)

    Example:

    { "lpn": "a123456789012345", "barcodes": [ "a123456789012345", "1234567890123456" ], "scanTime": "2018-08-02T16:53:35.111+00:00", "sortConfirmedTime": "2018-08-02T16:53:39.222+00:00", "jam": false, "laneFull": false, "out": false, "trailer": 123456, "dept": 6, "item": "123456789012", "zone": "D", "lane": 6, "sortConfirmedLane": 6, "sortResult": "OTHER_BARCODE", "status": "MULTIPLE_BARCODES"
    }

    Example:

    [ { "lpn": "a123456789012345", "barcodes": [ "a123456789012345", "1234567890123456" ], "scanTime": "2018-08-02T16:53:35.111+00:00", "sortConfirmedTime": "2018-08-02T16:53:39.222+00:00", "jam": false, "laneFull": false, "out": false, "trailer": 123456, "dept": 6, "item": "123456789012", "zone": "D", "lane": 6, "sortConfirmedLane": 6, "sortResult": "OTHER_BARCODE", "status": "MULTIPLE_BARCODES" }, { "lpn": "NO_READ", "barcodes": [], "scanTime": "2018-08-02T16:53:37.111+00:00", "sortConfirmedTime": null, "jam": null, "laneFull": null, "trailer": null, "out": null, "dept": null, "item": "", "zone": "", "lane": null, "sortConfirmedLane": null, "sortResult": "ERROR_FINDING_SORTLANE", "status": "NOT_FOUND" }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Exceptions

    SLA exceptions

    POST/store/{storeNbr}/receiving/exceptions

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • scanTime: required (datetime)
    • barcode: required (string - pattern: ^$|^[a-zA-Z0-9()+\-~*/ ]{8,50}$)
    • name: (one of WRONG_STORE, CODE_LENGTH, NOT_FOUND, WRONG_TRAILER)
    • detail: (string - pattern: ^$|^[a-zA-Z0-9()+\-~*/ ]{1,26}$)
    • trailer: required (integer | nil)
    • deviceID: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

    Example:

    [ { "scanTime": "2018-08-02T16:53:35.555+00:00", "barcode": "a123456789012345", "name": "WRONG_TRAILER", "detail": "139410", "trailer": 108817, "deviceID": "12312312-1231-3afc-efa1-234adf151234" }, { "scanTime": "2018-08-02T16:53:37.555+00:00", "barcode": "", "name": "NOT_FOUND", "detail": "", "trailer": null, "deviceID": "12312312-1231-3afc-efa1-234adf151234" }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Response Times

    Measured response times for services called by device

    POST/store/{storeNbr}/device/{deviceID}/sla-metrics

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • deviceID: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

      UUID for registered device

      Example:

      12345678-abcd-1234-5678-abcdef123456
    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • URI: required (string - pattern: ^((http|https|ftp):\/\/)?[-a-zA-Z0-9@:%_\+.~#?&/=]{1,10000}\.[a-z]{2,6}\/[a-zA-Z0-9@:%-_.~#?&/=]*$)
    • method: required (one of GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE)
    • statusCode: required (integer | nil)
    • startTime: required (datetime | nil)
    • endTime: required (datetime | nil)

    Example:

    [ { "URI": "http://www.testurl.com/postEndpoint/", "method": "POST", "statusCode": 401, "startTime": "2018-01-08T23:49:12.111+00:00", "endTime": "2018-01-08T23:49:12.222+00:00" }, { "URI": "http://www.testurl.com/getEndpoint/", "method": "GET", "statusCode": null, "startTime": null, "endTime": null }
    ]

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Status

    report device status

    POST/store/{storeNbr}/device/{deviceID}/status/{status}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • deviceID: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

      UUID for registered device

      Example:

      12345678-abcd-1234-5678-abcdef123456
    • status: required (one of START_TRAILER, END_TRAILER)

      Device status

    View Sample Body

    Media type: application/json

    Properties:

    • trailer: required (integer)
    • timestamp: required (datetime)

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Status Code

    report device status

    POST/store/{storeNbr}/device/{deviceID}/status/{statusCode}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • deviceID: required (string - pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)

      UUID for registered device

      Example:

      12345678-abcd-1234-5678-abcdef123456
    • statusCode: required (one of FAULT, OK)

      Device status

    View Sample Body

    Media type: application/json

    Properties:

    • code: required (integer)

      the status code of the reported status

    • cpuUtilization: (integer | nil)
    • memoryUtilization: (integer | nil)
    • components: (array of items)

      An array of component id's which exhibit the reported status

      • id: required (integer - minimum: 0)
      • code: required (integer - minimum: 0)
    • firmwareVersion: required (string - pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$)

      An id denoting the version of the firmware being used by the Fast device

    Examples:

    code:

    0

    cpuUtilization:

    25

    memoryUtilization:

    25

    firmwareVersion:

    1.2.3-4az.4az+5az.5az

    Response

    request accepted

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Server Error

    Service Unavailable

    Device registration

    Device registration to receive device ID

    POST/store/{storeNbr}/device/register/{deviceType}

    Request

    URI Parameters
    • storeNbr: required (type)

      Store Number

      Example:

      5260
    • deviceType: required (CASI)
    View Sample Body

    Media type: application/json

    Properties:

    • idHash: required (string - pattern: ^[a-f0-9]{40}$)

      Example:

      1234567890abcde1234567890abcde1234567890

    Response

    Ok

    View Sample Body

    Media type: application/json

    Type: string

    Example:

    12345678-abcd-1234-5678-abcdef123456

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Conflict

    View Sample Body

    Media type: application/json

    Type: string

    Example:

    12345678-abcd-1234-5678-abcdef123456

    Internal Server Error

    Service Unavailable

    Store Scans

    post scanned item data to the database

    POST/stores/scans

    Request

    View Sample Body

    Media type: application/json

    Type: array of items

    Items: items

    • userid: required (string - pattern: /^[a-zA-Z]+$/)

      Example:

      tests
    • itemNbr: required (string - pattern: /^[0-9]{4,12}$/)

      Example:

      130769
    • upcNbr: (string - pattern: /^[0-9]{4,12}$/)

      Example:

      553521328
    • timestamp: required (datetime)

      Example:

      2019-09-09T11:20:04.393Z
    • zone: required (string - pattern: /^[A-Z]{1}$/)

      Example:

      A
    • aisle: required (integer - minimum: 1 - maximum: 99)

      Example:

      1
    • section: required (integer - minimum: 1 - maximum: 999)

      Example:

      12

    Example:

    { "userid": "test", "itemNbr": "130769", "upcNbr": "553521328", "timestamp": "2019-11-28T00:32:28", "zone": "Z", "aisle": 21, "section": 12
    }
    

    Example:

    [ { "userid": "test", "itemNbr": "130769", "upcNbr": "553521328", "timestamp": "2019-11-28T00:32:28", "zone": "Z", "aisle": 21, "section": 12 }
    ]
    

    Response

    View Sample Body

    Media type: application/json

    Properties:

    • outs: required (array of items)

    Example:

    { "outs": [13769, 13770]
    }
    
    View Sample Body

    Media type: application/json

    Properties:

    • outs: required (array of items)
    • error: required (object)
      • /^[0-9]{4,12}$/: required (string)

    Example:

    { "outs": [13769, 13770], "error": { "13769": "Item rejected : Not found in system" }
    }
    
    View Sample Body

    Media type: application/json

    Properties:

    • outs: required (array of items)
    • error: required (object)
      • /^[0-9]{4,12}$/: required (string)

    Example:

    { "outs": [], "error": { "13769": "Item rejected : Not found in system" }
    }
    

    Internal Service Error

    Aisle List by Store

    returns the expected aisles list by store

    GET/stores/scans/expectedAisles

    Request

    Query Parameters
    • stores: required (array of items)

      store list

    Response

    Ok

    View Sample Body

    Media type: application/json

    Properties:

    • /^[1-9]{1}[0-9]{0,4}$/: required (array of items)

      store

      • name: required (string)

        scan name

      • start: required (string - pattern: ^(?:[0-1]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.(?:0{6}|9{6}))?$)

        scan start time

      • end: required (string - pattern: ^(?:[0-1]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.(?:0{6}|9{6}))?$)

        scan end time

      • timezone: required (string)

        time zone

      • values: required (array of items)

        aisle list

    Example:

    { "54": [ { "name": "scan1", "start": "00:00:00.000000", "end": "06:29:59.999999", "timezone": "America/New York", "values": [ "A16", "J5" ] }, { "name": "scan2", "start": "00:00:00.000000", "end": "06:29:59.999999", "timezone": "America/New York", "values": [ "E2", "J8", "A19" ] } ], "4574": [ { "name": "scan1", "start": "00:00:00.000000", "end": "06:29:59.999999", "timezone": "America/New York", "values": [ "K21", "K9" ] } ]
    }

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Service Error

    Service Unavailable

    List by Scan

    returns the expected department list by store by scan

    GET/stores/scans/expectedDepartments

    Request

    Query Parameters
    • stores: required (array of items)

      store list

    Response

    Ok

    View Sample Body

    Media type: application/json

    Properties:

    • /^[1-9]{1}[0-9]{0,4}$/: required (array of items)

      store

      • name: required (string)

        scan name

      • start: required (string - pattern: ^(?:[0-1]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.(?:0{6}|9{6}))?$)

        scan start time

      • end: required (string - pattern: ^(?:[0-1]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.(?:0{6}|9{6}))?$)

        scan end time

      • timezone: required (string)

        time zone

      • values: required (array of items)

        department list

    Example:

    { "54": [ { "name": "scan1", "start": "00:00:00.000000", "end": "06:29:59.999999", "timezone": "America/New York", "values": [ 16, 15 ] }, { "name": "scan2", "start": "00:00:00.000000", "end": "06:29:59.999999", "timezone": "America/New York", "values": [ 2, 8, 19 ] } ], "4574": [ { "name": "scan1", "start": "00:00:00.000000", "end": "06:29:59.999999", "timezone": "America/New York", "values": [ 21, 9 ] } ]
    }

    Bad request. The format of the request failed validation.

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Service Error

    Service Unavailable

    All Stores Scan Data

    returns the expected aisles list by store and department for all the stores and depts

    GET/stores/scans/aislesByDept

    Request

    Query Parameters
    • stores: required (array of items)

      store list

    • depts: required (array of items)

      department list

    Response

    Ok

    View Sample Body

    Media type: application/json

    Properties:

    • /^[1-9]{1}[0-9]{0,4}$/: required (object)

      store

      • /^[1-9][0-9]?$/: required (array of items)

        department

    Example:

    { "1083": { "1": [ "A23", "A3", "T10" ] }
    }

    Bad or expired token. You should re-authenticate the user.

    Authentication failed (wrong consumer key, bad nonce, expired timestamp...).

    Internal Service Error

    Service Unavailable