For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • GETGets multiple product variants
      • POSTAdds new product variants to a product
      • PATCHUpdates multiple product variants
      • POSTCreate a new Channel Metadata Entry for a given Variant
      • GET Gets Product by Id
      • DELDeletes Bundle and removes associations to related products
      • PATCHUpdate a single product with Json Merge Patch functionality
      • GET Gets Taxonomy by Id
      • GETRetrieves List of Products based on filters provided
      • POSTCreate single product to the store
      • GET Gets Taxonomy
      • POSTUsed to merge two or more variants together
      • PUTUpdate specific channel metadata record from a variant by channel metadata ID
      • DELUsed to delete a specific channel metadata record from a variant by channel metadata ID
      • POSTMigrates variants to existing product
      • GET Gets Taxonomy Parent
      • POSTMigrates existing variants to a new product
      • GETGets Packaging Requirement
      • POSTAdd new product variants to a product
LogoLogo
API ReferenceProducts

Gets Taxonomy

||View as Markdown|
GET
https://sandbox-api.shipbob.com/Experimental/taxonomy
GET
/Experimental/taxonomy
$curl -G https://sandbox-api.shipbob.com/Experimental/taxonomy \
>     -H "Authorization: Bearer <token>" \
>     -d search=string
1[
2  {
3    "children": [
4      {
5        "has_children": true,
6        "id": 0,
7        "name": "string",
8        "path": "string"
9      }
10    ],
11    "id": 0,
12    "name": "string",
13    "parent": {
14      "id": 0,
15      "name": "string",
16      "path": "string"
17    },
18    "path": "string"
19  }
20]
Was this page helpful?
Previous

Create single product to the store

Next

Used to merge two or more variants together

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

searchstringOptional

Response

Success
childrenlist of objects
idinteger
namestring
parentobject or null
pathstring

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error