Storesome functional specification

General overview of the marketplace

Our own internal solution that we are building as a SAAS platform for marketplaces.

The integration should be of full scale(orders, listings, stock updates, price updates).

The seller API documentation can be found here: Documentation

Credentials to use:

user: vesela+5@storesome.com

pass: Vesela=1

Seller id: 1

Flows to be used

• Price update • Create listing • Update listing | • Download orders • Mark orders as Dispatched | |

Authentication - specifics

Authorization header using the Bearer scheme Name: Authorization

In: header

When you obtain the token using the credentials you need to add Bearer in front of the actual API key.

Token will expire in: 1 day.

Product flows - specifics

1. Product Creation -

2. Single -

3. Variation -

4. Product update -

5. Single -

6. Variation -

7. Stock updates

Updates are done by SKU

8. Price updates -

9. Zero quantity updates -

10. Delist / Deactivate / End / Remove

At first only by updating with zero stock.

11. Any other -

Orders flows - specifics

1. Get orders - Download orders will be working fairly straightforward

There is both pagination and filtering by date updated.

• Marketplace order ID.
• Total cost
• Shipping cost
• Items on order
• Buyer's shipping address

If you use both of these time stamps you will be able to query for new orders or for orders that were updated for some reason. At the current version there are no other updates on orders expected then the shipping status.

2. Ship orders - Update the orders as Dispatched is fairly straightforward.

You won't be able to mark separate items as shipped you will have to mark the whole order except in the case where the order contains products from more then one seller. In this case you will be able to mark only the items for the integrated seller.

Updates are going to be done using the Marketplace order ID.

3. Cancel orders -

4. Refund orders -

5. Any other -

Use the following payload for Downloading orders:

{
  "pageSize": 0,
  "pageIndex": 0,
  "totalItems": 0,
  "items": [
    {
      "id": 0,
      "trackingId": "string",
      "carrierName": "string",
      "orderDate": "2021-03-31T06:42:59.799Z",
      "modifiedDate": "2021-03-31T06:42:59.799Z",
      "totalPrice": 0,
      "totalShippingPrice": 0,
      "orderItems": [
        {
          "id": 0,
          "title": "string",
          "quantity": 0,
          "totalPrice": 0,
          "totalShippingPrice": 0,
          "shippingTitle": "string",
          "shippingPrice": "string",
          "productSKU": "string",
          "orderItemLines": [
            {
              "lineId": 0,
              "status": "string"
            }
          ]
        }
      ],
      "address": {
        "addressLine": "string",
        "recipientFirstName": "string",
        "recipientLastName": "string",
        "phone": "string",
        "city": "string",
        "country": "string",
        "postcode": "string"
      },
      "status": "string",
      "paymentType": "string",
      "currency": "string",
      "transactionId": "string",
      "buyerName": "string",
      "buyerEmail": "string",
      "postcode": "string"
    }
  ]
}

}

Other - specifics

Outstanding questions