Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
Products

Save a product with the given ID

This endpoint both saves and updates a product. The product is identified by the id path parameter. If the product ID does not exist, then a new product with the corresponding ID will be created. Otherwise, the existing product will be modified.

put/v3/products/{id}

Path parameters

idstring required

Unique Product identifier.

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

OK. The product was updated.

messagestring
uristring

Example response

{
  "message": "Product updated successfully",
  "uri": "https://company.api.zephr.com/v3/products/gold"
}