Get and Find Storages

Pagination support for each method in this page:

1. Get storage list

Description

The call is used to obtain and filtering available storages in our system.

Using this method, a choice is made to send product items to Receipt for the storage owner.

Calling

GET /storages

Calling without parameters return all storages.

You can also filter them by certain parameters.

?address={address}&
    city={city}&
    country={country}&
    postCode={postCode}&
    title={title}

Get Parameters

Parameter Key Name	Description
{address}	Filter storages by address
{city}	Filter storages by city
{country}	Filter storages by country
{postCode}	Filter storages by post code
{title}	Filter storages by name

Response

200 - Successful request

[
  {
    "id": "string",     // Storage UUID
    "title": "string",  // Storage name
    "pictures": [       // Storage logo
      {
        "path": "/uploads/{filename}.png",
        "type": "cover"
      }
    ],

    // Data section for location of this storage 
    "country": "string",
    "city": "string",
    "address":  "string",
    "postCode": "string",
    "latitude": 0,
    "longitude": 0
  }
]

400 - Invalid request

{
  "message": "string"
}

---

2. Get storage list by item externalId

Description

The call is used to show a list of storages where this or that product has been accepted by one or another storage.

Calling

GET /{qwqerId}/storages/item/{externalId}

Get parameters

Parameter Key Name	Description
qwqerId	Marketplace UUID
externalId	Unique identifier of product item in your system

Response

200 - Successful request

[
  {
    "id": "string",
    "pictures": [
      {
        "path": "/uploads/{filename}.png",
        "type": "cover"
      }
    ],
    
    // Data section for location of this storage,
    "country": "string",
    "city": "string",
    "address":  "string",
    "postCode": "string",
    "latitude": 0,
    "longitude": 0,

    "itemQuantity": 0 // Available quantity of product on this storage
  }
]

400 - Invalid request

{
  "message": "string"
}

---

3. Get storage list by seller external id

Description

The call is used to obtain a list of available storages for a particular seller on the marketplace.

Unlike the two previous methods, the response contains all the data created by Receipt, Item and Sale assigned to a particular storage.

Calling

GET /{qwqerId}/storages/seller/{sellerId}

Get parameters

Parameter Key Name	Description
qwqerId	Marketplace UUID
sellerId	Unique identifier of seller in your system

Response

200 - Successful request

[
  {
    "id": "string",
    "pictures": [
      {
        "path": "/uploads/{filename}.png",
        "type": "cover"
      }
    ],
    
    // Data section for location of this storage,

    "country": "string",
    "city": "string",
    "address":  "string",
    "postCode": "string",
    "latitude": 0,
    "longitude": 0,
    
    // Additional data about Item, Receipt, Sale
    "items": [
      {
        "id": "string",
        "externalId": "string",
        "quantity": 0,
        "title": "string",
        "sellerExternalId": "string",
        "profitPercent": 0,
        "price": 0,
        "sku": "string",
        "externalLink": "string",
        "createdAt": "string",
        "specs": [
          {
            "id": "string",
            "value": "string"
          }
        ],
        "receipts": [
          {
            "id": "string",
            "items": [
              {
                "id": "string",
                "quantity": 0
              }
            ],
            "status": "string",
            "createdAt": "string",
            "receivedAt": "string",
            "trackingLink": "string"
          }
        ],
        "sales": [
          {
            "id": "string",
            "quantity": 0,
            "status": "string",
            "externalId": "string",
            "deliveryCountry": "string",
            "deliveryCity": "string",
            "deliveryAddress": "string",
            "latitude": 0,
            "longitude": 0,
            "buyerFullName": "string",
            "buyerPhone": "string"
          }
        ]
      }
    ]
  }
]

400 - Invalid request

{
  "message": "string"
}