Products

Retrieves a product by code.

get/products/{code}

Path parameters

codestring required

Product code. Must not include #, /, or :.

Example:PROD_001

Response

Success

Example response

{
  "data": {
    "id": "product_1234567890",
    "workspace_id": "ws_1234567890",
    "code": "PROD_001",
    "description": "Premium subscription service",
    "update_version": 1,
    "created": "2024-01-13T00:00:00Z"
  }
}

Changes

Changed in 9 of the 38 revisions of this API.914

    • removed the required property data/paid_by_roles from the response with the 200 status

      response-required-property-removed

    • removed the required property data/paid_to_roles from the response with the 200 status

      response-required-property-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the required property data/updateVersion from the response with the 200 status

      response-required-property-removed

    • removed the required property data/workspaceId from the response with the 200 status

      response-required-property-removed

    • the response property data/description became optional for the status 200

      response-property-became-optional

    • response property data/updateVersion deprecated

      response-property-deprecated

    • response property data/workspaceId deprecated

      response-property-deprecated

    • added the required property data/update_version to the response with the 200 status

      response-required-property-added

    • added the required property data/workspace_id to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the required property data/seller from the response with the 200 status

      response-required-property-removed

    • added the required property data/id to the response with the 200 status

      response-required-property-added

    • added the required property data/paid_by_roles to the response with the 200 status

      response-required-property-added

    • added the required property data/paid_to_roles to the response with the 200 status

      response-required-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added UserSeller to the data/seller response property anyOf list for the response status 200

      response-property-any-of-added

    • removed CounterpartySeller from the data/seller response property anyOf list for the response status 200

      response-property-any-of-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e106f73e699911See the full diff
    • api path removed without deprecation

      api-path-removed-without-deprecation

    • endpoint added

      endpoint-added

  • aea46314e2f711See the full diff
    • api path removed without deprecation

      api-path-removed-without-deprecation

    • endpoint added

      endpoint-added

  • c985e59e074811See the full diff
    • api path removed without deprecation

      api-path-removed-without-deprecation

    • endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security oauth2 was added to the API

      api-security-added

    • the endpoint scheme security Bearer was removed from the API

      api-security-removed