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.

SecurityZephrHmacHttp

Request

Request Body schema: application/json

label required	string The product label. This is the human-readable name of the product.
description	string The product description. This is a human-readable description of the product.
required	object (product.entitlement)
required	object (product.mapping)
sharingLimit	number The number of other users that the purchaser of this product can share the product with.

Responses

201

Created. The product was created.

400

Bad Request. Returned if the request body is invalid.

401

Unauthorized. Returned if no valid authentication was provided.

409

Conflict. Returned when missing a reference to the entitlement.

post/v3/products

Request samples

Payload

application/json

{"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 samples

application/json

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