Get Product

GET 
/commerce/products/:productId

Get product for a specified connection

Request

Path Parameters

productId stringrequired

The product ID of the item

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

any

Result

{
  "product": {
    "remoteId": "1234567890123",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
    "productType": "Apparel",
    "productName": "Example Shirt",
    "description": "A stylish shirt for all occasions.",
    "images": [],
    "productStatus": "ACTIVE",
    "tags": ["Fashion", "Comfort"],
    "vendor": "Example Vendor",
    "productUrl": "https://example.com/products/example-shirt",
    "id": "00112233-4455-6677-8899-aabbccddeeff",
    "variants": [
      {
        "remoteId": "200100200100",
        "productId": "00112233-4455-6677-8899-aabbccddeeff",
        "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
        "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
        "remoteDeleted": false,
        "createdAt": "2024-02-22T11:17:53.264Z",
        "updatedAt": "2024-02-22T13:54:03.445Z"
        "title": "Medium",
        "price": "25.00",
        "sku": "SHIRT-M",
        "optionValues": [
          {
            "name": "Size", 
            "value": "Medium"
          }
        ],
        "inventory": {"totalCount": 50},
        "weight": [
          {
            "value": 0.5,
            "unit": "kg"}
        ],
        "id": "11001100-1122-3344-5566-77889900aabb"
      }
    ]
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...