Products

Creates a product.

post/products

Request body

codestring required

Unique product code.

descriptionstring

Product description.

Example request

{
  "code": "PROD_001",
  "description": "Premium subscription service"
}

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 7 of the 38 revisions of this API.9317

  • 91a072ddf86d22See the full diff
    • removed the required property data/paid_by_roles from the response with the 201 status

      response-required-property-removed

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

      response-required-property-removed

    • removed the request property paid_by_roles

      request-property-removed

    • removed the request property paid_to_roles

      request-property-removed

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

  • 8472a9bd15ea22See the full diff
    • removed subschema #1 subschema #2 from the paid_by_roles/items/ request property anyOf list

      request-property-any-of-removed

    • removed subschema #1 subschema #2 from the paid_to_roles/items/ request property anyOf list

      request-property-any-of-removed

    • added subschema #1 subschema #2 to the paid_by_roles/items/ request property anyOf list

      request-property-any-of-added

    • added subschema #1 subschema #2 to the paid_to_roles/items/ request property anyOf list

      request-property-any-of-added

    This revision also has 18 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 201 status

      response-required-property-removed

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

      response-required-property-removed

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

      response-property-became-optional

    • the request property description became optional

      request-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 201 status

      response-required-property-added

    • added the required property data/workspace_id to the response with the 201 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

  • 635b1d55b735115See the full diff
    • removed the required property data/seller from the response with the 201 status

      response-required-property-removed

    • removed the request property seller

      request-property-removed

    • added the new optional request property paid_by_roles

      new-optional-request-property

    • added the new optional request property paid_to_roles

      new-optional-request-property

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

      response-required-property-added

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

      response-required-property-added

    • added the required property data/paid_to_roles to the response with the 201 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

    • removed CounterpartySeller from the seller request property anyOf list

      request-property-any-of-removed

    • added UserSeller to the seller request property anyOf list

      request-property-any-of-added

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

      response-property-any-of-added

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

      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

    • 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