API Documentation

This service is in BETA. For access please Fill out the application

CONTENTS
RESOURCES
MACROS
VERBS
REPORTS
RESEARCH API

Locations /v1/locations

The locations resource describes the various locations that are available for use within SLAPI.


Object model

Name Type Required Description
id string Generated Integer ID for the location
display string (255) Yes a Friendly name for the location
order int (0-32767) Yes order to be used when sorting this location (ie: for use in picking)
type enum Yes See below for more information on allowed types
ref string No A Reference ID for this location (ie: FBA Shipment ID, PO #, etc)
notes string No Notes for this location
canMove bool Read-only Whether or not items can be moved from this location using doMoveItem
canMoveFBA bool Read-only Whether or not items can be moved from this location using doSendToFBA
created date No Created Timestamp
modified date No Last Modified Timestamp

Location Types

Type Description
shelf A Shelf, or bin within a warehouse
fba Units within Amazon's Fulfillment Center network
fbaShipment A shipment bound for an Amazon fulfillment center
shipment A shipment between locations or inbound from a supplier
unfulfillable Inventory that is not ready to be sold or reported as lost

Methods

Method Description
GET /locations Gets a collection of all locations
GET /locations/{id} Gets a specific location
POST /locations Creates a new location
POST /locations/{id} Updates a specific location
PUT /location/{id} Updates a specific location

GET Collection /v1/locations

Gets a collection of all locations

REQUEST
    GET https://api.sellerlabs.com/items HTTP/1.1
RESPONSE
    HTTP/1.1 200 OK
Content-Length: 0
Keep-Alive: timeout=5, max=99
Connection: Keep-Alive
Content-Type: application/json

{
    "status": "success",
    "code": 200,
    "httpCode": "200",
    "user": "123",
    "data": {
        "offset": 0,
        "limit": 50,
        "count": "3",
        "prev": "",
        "next": "",
        "first": "/locations?offset=0&limit=50",
        "last": "/locations?offset=0&limit=50",
        "pages": 1,
        "locations": [
            {
                "id": "26",
                "display": "test3",
                "order": "0",
                "type": "shelf",
                "ref": "",
                "notes": "",
                "created": "2014-07-20T23:04:06Z",
                "modified": "2014-07-20T23:04:06Z",
                "canMove": true,
                "canMoveFBA": true,
                "link": "https://api.sellerlabs.com/v1/locations/26"
            },
            {
                "id": "14",
                "display": "testing",
                "order": "1",
                "type": "shelf",
                "ref": "",
                "notes": "",
                "created": "2014-05-21T04:23:21Z",
                "modified": "2014-07-13T23:53:05Z",
                "canMove": true,
                "canMoveFBA": true,
                "link": "https://api.sellerlabs.com/v1/locations/14"
            },
            {
                "id": "12",
                "display": "FBA Shipment FBA1TR9FR7 to PHX3 created",
                "order": "0",
                "type": "fbaShipment",
                "ref": "A2YSNX94F6FRNU:ATVPDKIKX0DER:FBA1TR9FR7:SELLER_LABEL",
                "notes": "FBA Shipment FBA1TR9FR7 to PHX3 / SELLER_LABEL created 05/19/2014 for merchantId=A2YSNX94F6FRNU and marketplaceId=ATVPDKIKX0DER",
                "created": "2014-05-19T18:49:57Z",
                "modified": "2014-05-19T18:49:57Z",
                "canMove": false,
                "canMoveFBA": false,
                "link": "https://api.sellerlabs.com/v1/locations/12"
            }
        ]
    }
}

GET Object /v1/locations/{id}

Gets the location object with the specified id

REQUEST
    GET https://api.sellerlabs.com/locations/26 HTTP/1.1
RESPONSE
    HTTP/1.1 200 OK
Content-Length: 253
Keep-Alive: timeout=5, max=99
Connection: Keep-Alive
Content-Type: application/json

{
    "status": "success",
    "code": 200,
    "httpCode": "200",
    "user": "123",
    "data": {
        "id": "26",
        "display": "test3",
        "order": "0",
        "type": "shelf",
        "ref": "",
        "notes": "",
        "created": "2014-07-20T23:04:06Z",
        "modified": "2014-07-20T23:04:06Z",
        "canMove": true,
        "canMoveFBA": true,
        "link": "https://api.sellerlabs.com/v1/locations/26"
    }
}

POST Collection /v1/locations/

Creates a new location

REQUEST
    POST https://api.sellerlabs.com/locations/ HTTP/1.1
Content-Type: application/json

{
    "display": "Electronics aisle",
    "type": "shelf",
    "order": 1
}
RESPONSE
    HTTP/1.1 200 OK
Content-Length: 253
Keep-Alive: timeout=5, max=99
Connection: Keep-Alive
Content-Type: application/json

{
    "status": "success",
    "code": 200,
    "httpCode": "200",
    "user": "123",
    "data": {
        "id": "28",
        "display": "Electronics aisle",
        "order": "1",
        "type": "shelf",
        "ref": "",
        "notes": "",
        "created": "2014-07-20T23:04:06Z",
        "modified": "2014-07-20T23:04:06Z",
        "canMove": true,
        "canMoveFBA": true,
        "link": "https://api.sellerlabs.com/v1/locations/28"
    }
}

POST Object /v1/locations/{id}

Updates an existing location (See POST collection for request/response format)

PUT Object /v1/locations/{id}

Updates an existing location (See POST collection for request/response format)