Product

Get product

Get a product by ID from the Terminal shop.

get/product/{id}

Path parameters

idstring required

ID of the product to get.

Example:prd_XXXXXXXXXXXXXXXXXXXXXXXXX

Response

The requested product.

Example response

{
  "data": {
    "id": "prd_XXXXXXXXXXXXXXXXXXXXXXXXX",
    "name": "[object Object]",
    "description": "The interpolation of Caturra and Castillo varietals from Las Cochitas creates this refreshing citrusy and complex coffee.",
    "variants": [
      {
        "id": "var_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "name": "12oz",
        "price": 2200
      }
    ],
    "order": 100,
    "subscription": "allowed",
    "tags": {
      "featured": true
    },
    "filters": []
  }
}

Changes

Changed in 7 of the 41 revisions of this API.3224

Aug 5, 202584ef614abb9711See the full diff
- ●
  removed the optional property data/allOf[Product]/variants/items/description from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property data/allOf[Product]/timeHidden to the response with the 200 status
  response-optional-property-added
Apr 24, 2025007e5b7479981See the full diff
- ○
  added the optional property data/allOf[Product]/variants/items/description to the response with the 200 status
  response-optional-property-added
Apr 24, 2025128873249a642See the full diff
- ○
  added the optional property data/allOf[Product]/tags/market_global to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/allOf[Product]/variants/items/tags to the response with the 200 status
  response-optional-property-added
Mar 19, 20251c6726b12e29318See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 429
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed ErrorResponse from the response body allOf list for the response status 404
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 429
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 500
  response-body-all-of-removed
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property code to the response with the 429 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 429 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 429 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
Mar 13, 2025cb50019f24251See the full diff
- ●
  removed the optional property data/allOf[Product]/tags/type from the response with the 200 status
  response-optional-property-removed
Mar 11, 20253b68749c34dc1See the full diff
- ○
  added the optional property data/allOf[Product]/tags/type to the response with the 200 status
  response-optional-property-added
Mar 7, 2025979a6c40552c1See the full diff
- ○
  endpoint added
  endpoint-added

Full history