List all products

Parameters

clientIdqueryFilter to one 3PL client's catalog.

Responses

200List of products

dataobject[]required

idstring (uuid)required

clientIdstring (uuid)required

Owning 3PL client id; null = house-owned.

skustringrequired

namestringrequired

descriptionstringrequired

categorystringrequired

weightstringrequired

lengthstringrequired

widthstringrequired

heightstringrequired

imageUrlstringrequired

createdAtstringrequired

updatedAtstringrequired

customFieldsobjectrequired

Custom field values keyed by field name. Every defined product field is present; null when unset.

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

Request

curl -X GET 'https://v3.revolutionstreetwxs.io/api/v3/products' \
  -H "Authorization: Bearer wxs_pk_YOUR_API_KEY"

const response = await fetch("https://v3.revolutionstreetwxs.io/api/v3/products", {
  method: "GET",
  headers: {
    Authorization: "Bearer wxs_pk_YOUR_API_KEY",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://v3.revolutionstreetwxs.io/api/v3/products",
    headers={"Authorization": "Bearer wxs_pk_YOUR_API_KEY"},
)
data = response.json()

Response 200

{
  "data": [
    {
      "id": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "clientId": "3f9c2c6e-9d0b-4b62-8f7d-2a4b9e1c5d10",
      "sku": "SKU-ABC-001",
      "name": "Example",
      "description": "Example note",
      "category": "category",
      "weight": "weight",
      "length": "length",
      "width": "width",
      "height": "height",
      "imageUrl": "image url",
      "createdAt": "created at",
      "updatedAt": "updated at",
      "customFields": {}
    }
  ]
}