Add Product To Family

POST

/api/:account_id/product-families/:family_id/products

Add a product to a family's hierarchy.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

family_idstringRequired

account_idstringRequired

This endpoint expects an object.

product_idstringRequired

ID of the product

rankintegerRequired>=1

Rank in hierarchy

Successful Response

idstring

account_idstring

namestring

created_atdatetime

updated_atdatetime

descriptionstring or nullOptional

hierarchymap from strings to integersOptional

deleted_atdatetime or nullOptional

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/product-families/family_id/products \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"product_id": "prod_987654321",
>	"rank": 3
>	}'

1	{
2	"id": "fam_123456789",
3	"account_id": "acc_456789123",
4	"name": "Winter Apparel Collection",
5	"created_at": "2023-11-01T08:00:00Z",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"description": "A curated selection of winter clothing products.",
8	"hierarchy": {},
9	"deleted_at": "2024-01-15T09:30:00Z"
10	}