Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
Products

Save a product

This endpoint saves a product with the given details specified in the body of the request. The product ID is randomyly generated and provided as part of the URI path parameter response returned on success.

post/v3/products

Request body

labelstring required

The product label. This is the human-readable name of the product.

descriptionstring

The product description. This is a human-readable description of the product.

sharingLimitnumber

The number of other users that the purchaser of this product can share the product with.

Example request

{
  "label": "Gold Subscription",
  "description": "The most premium subscription.",
  "entitlement": {
    "id": "gold-bundle",
    "type": "bundle",
    "entitlementTenant": "company"
  },
  "mapping": {
    "braintree_one_off": {
      "price_points": [
        {
          "id": "ten",
          "label": "Ten Dollars",
          "price": 10
        }
      ]
    }
  },
  "sharingLimit": 5
}

Response

Created. The product was created.

messagestring
uristring

Example response

{
  "message": "Product created successfully",
  "uri": "https://company.api.zephr.com/v3/products/63b68935-c996-4e90-b88a-dd6a133a7a3"
}