Taxons
Create a Taxon
Storefront API
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Taxons
Create a Taxon
Creates a Taxon
POST
/
api
/
v2
/
platform
/
taxons
curl --request POST \
--url http://{defaultHost}/api/v2/platform/taxons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"taxon": {
"taxonomy_id": "<string>",
"parent_id": "<string>",
"name": "<string>",
"public_metadata": {
"ability_to_recycle": "90%"
},
"private_metadata": {
"profitability": 2
}
}
}'
{
"data": {
"id": "47",
"type": "taxon",
"attributes": {
"position": 0,
"name": "taxon_17",
"permalink": "taxonomy-27/taxon-17",
"lft": 4,
"rgt": 5,
"description": null,
"created_at": "2022-11-08T19:35:50.279Z",
"updated_at": "2022-11-08T19:35:50.283Z",
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"depth": 1,
"public_metadata": {},
"private_metadata": {},
"pretty_name": "taxonomy_27 -> taxon_17",
"seo_title": "taxon_17",
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"parent": {
"data": {
"id": "45",
"type": "taxon"
}
},
"taxonomy": {
"data": {
"id": "27",
"type": "taxonomy"
}
},
"children": {
"data": []
},
"image": {
"data": null
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Body
application/json
Was this page helpful?
curl --request POST \
--url http://{defaultHost}/api/v2/platform/taxons \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"taxon": {
"taxonomy_id": "<string>",
"parent_id": "<string>",
"name": "<string>",
"public_metadata": {
"ability_to_recycle": "90%"
},
"private_metadata": {
"profitability": 2
}
}
}'
{
"data": {
"id": "47",
"type": "taxon",
"attributes": {
"position": 0,
"name": "taxon_17",
"permalink": "taxonomy-27/taxon-17",
"lft": 4,
"rgt": 5,
"description": null,
"created_at": "2022-11-08T19:35:50.279Z",
"updated_at": "2022-11-08T19:35:50.283Z",
"meta_title": null,
"meta_description": null,
"meta_keywords": null,
"depth": 1,
"public_metadata": {},
"private_metadata": {},
"pretty_name": "taxonomy_27 -> taxon_17",
"seo_title": "taxon_17",
"is_root": false,
"is_child": true,
"is_leaf": true
},
"relationships": {
"parent": {
"data": {
"id": "45",
"type": "taxon"
}
},
"taxonomy": {
"data": {
"id": "27",
"type": "taxonomy"
}
},
"children": {
"data": []
},
"image": {
"data": null
}
}
}
}