Skip to content

Save a product

Request

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.

Security
ZephrHmacHttp
Bodyapplication/json
labelstringrequired

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

Example:"Gold Subscription"
descriptionstring

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

Example:"The most premium subscription."
entitlementobject(product.entitlement)required
mappingobject(product.mapping)required
Example:
{ "braintree_one_off": { "price_points": [ … ] } }
sharingLimitnumber

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

Example:5
{ "label": "Gold Subscription", "description": "The most premium subscription.", "entitlement": { "id": "gold-bundle", "type": "bundle", "entitlementTenant": "company" }, "mapping": { "braintree_one_off": { … } }, "sharingLimit": 5 }

Responses

Created. The product was created.

Headers
any
Bodyapplication/json
messagestring
Example:"Product created successfully"
uristring
Example:"https://company.api.zephr.com/v3/products/63b68935-c996-4e90-b88a-dd6a133a7a3"
Response
{ "message": "Product created successfully", "uri": "https://company.api.zephr.com/v3/products/63b68935-c996-4e90-b88a-dd6a133a7a3" }