How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ShipBob subpackage_products API

The subpackage_products API from ShipBob — 11 operation(s) for subpackage_products.

ShipBob subpackage_products API is one of 10 APIs that ShipBob publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, release notes, and rate-limit docs.

This API exposes 16 operations across 11 paths, and defines 108 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.shipbob.com, https://sandbox-api.shipbob.com.

16 operations 11 paths 108 schemas 1 DELETE7 GET2 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.shipbob.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ShipBob subpackage_products API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PAT).

  • PAT — Authentication using Personal Access Token (PAT) token or OAuth2

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 1 DELETE, 7 GET, 2 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_products 16
POST
/2026-01/product
Create Product
create-product 1 param body → 201
GET
/2026-01/product
Get Products
get-products 27 params → 200400404
GET
/2026-01/product/{productId}
Get Product
get-product 2 params → 200400404
PATCH
/2026-01/product/{productId}
Update Product
update-product 2 params body → 200
DELETE
/2026-01/product/{productId}
Delete Product Bundle
delete-product-bundle 2 params → 200400404
GET
/2026-01/product/{productId}/variants
Get Product Variants
get-product-variants 2 params → 200400404
POST
/2026-01/product/{productId}/variants
Add Product Variants
add-product-variants 2 params body → 201
PATCH
/2026-01/product/{productId}/variants
Update Product Variants
update-product-variants 2 params body → 200
POST
/2026-01/variant/{variantId}:merge
Merge Variants
merge-variants 2 params body → 201
POST
/2026-01/product/{productId}:moveVariants
Move Variants Between Products
move-variants-between-products 2 params body → 201400404
POST
/2026-01/product:moveVariants
Move Variants to New Product
move-variants-to-new-product 1 param body → 201400404
GET
/2026-01/packaging-requirement
Get Packaging Requirement
get-packaging-requirement 1 param → 200
GET
/2026-01/taxonomy
Get Taxonomies
get-taxonomies 2 params → 200401403500503
GET
/2026-01/taxonomy/{id}
Get Taxonomy by ID
get-taxonomy-by-id 2 params → 200401403404500503
GET
/2026-01/taxonomy/{id}/parent
Get Taxonomy Parent
get-taxonomy-parent 2 params → 200401403404500503
POST
/2026-01/variant/{variantId}:convertToBundle
Convert Variant to Bundle
convert-variant-to-bundle 2 params body → 201

Schemas 108

The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are Products.VariantInternalViewModel (28 properties), Products.VariantInternalViewModelV5 (27 properties), Products.VariantViewModel (27 properties), Products.VariantViewModelV5 (26 properties). Each schema is shown below with its type and property counts.

Products.MergeVariantRequestModelArray
array
Products.VariantViewModel
object
27 properties
Products.MergedChildrenViewModel
object
5 properties
Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.ShopifyChannelMetadataRequestModel
object
Shopify Sales Channel Information
10 properties
Products.WeightViewModel
object
2 properties
Products.CreateProductVariantRequestModelV5Array
array
Products.ProblemDetails
object
5 properties
Products.HttpValidationProblemDetails
object
6 properties
Products.BaseReturnPreferencesModel
object
5 properties
Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.BaseAdditionalHazmatAttributesModel
object
8 properties
ProductsBaseProductVariantRequestModelChannelMetadataItems
ProductsBaseProductRequestModelTypeId
string
The product type ID (1 = Regular, 2 = Bundle)
Products.ProductViewModel
object
10 properties
Products.SerialScanRequestModel
object
4 properties
Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.ProductViewModelV5
object
8 properties
ProductsTaxonomyViewModelParent
Parent taxonomy node in the category hierarchy
Products.UpdateProductVariantModelV5
object
20 properties
Products.AmazonProductChannelMetadataModel
object
14 properties
Products.BigCommerceProductChannelMetadataModel
object
13 properties
Products.ShopifyChannelMetadataViewModel
object
11 properties
Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.ProductViewModelV5PagedResponse
object
5 properties
Products.VariantInternalViewModelV5
object
27 properties
Products.AmazonChannelMetadataRequestModel
object
Amazon Sales Channel Information with custom Amazon Fields
13 properties
Products.TaxonomyViewModel
object
5 properties
Products.MigrateVariantRequestModel
object
6 properties
Products.TaxonomyViewModelArray
array
Products.BaseCustomsModel
object
6 properties
Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.ChannelMetadataViewModel
object
11 properties
Products.BaseFulfillmentSettingsModel
object
6 properties
Products.BaseProductChannelMetadataModel
object
11 properties
ProductsProductViewModelVariantsItems
ProductsProductViewModelV5VariantsItems
Products.CreateProductVariantRequestModelV5
object
18 properties
Products.AmazonChannelMetadataViewModel
object
14 properties
Products.BarcodeRequestModel
object
2 properties
Products.EnumViewModel
object
2 properties
Products.BarcodeViewModel
object
2 properties
Products.ReviewsPendingType
string
Products.SerialScanViewModel
object
4 properties
Products.UpdateProductVariantRequestModelV5
object
19 properties
Products.FulfillmentSettingsRequestModel
object
6 properties
Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.PackagingRequirementViewModelArray
array
Products.Get.Api.V5.Product.ProductId.Bad.Request.Object
object
Products.ReturnPreferencesRequestModel
object
5 properties
Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.CreateProductRequestModelV5
object
5 properties
Products.ShopifyProductChannelMetadataModel
object
11 properties
Products.BarcodeModel
object
2 properties
Products.CustomsViewModel
object
6 properties
Products.PackagingMaterialTypeViewModel
object
2 properties
Products.BaseLotInformationModel
object
2 properties
Products.BundleDefinitionViewModel
object
5 properties
Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object
object
Products.BaseDimensionModel
object
3 properties
Products.UpdateProductRequestModelV5
object
5 properties
Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.AssociatedBundlesViewModel
object
5 properties
Products.ChildTaxonomyViewModel
object
4 properties
Products.DimensionViewModel
object
6 properties
Products.BaseSerialScanModel
object
4 properties
Products.ComplianceViewModel
object
3 properties
Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object
object
Products.LotInformationRequestModel
object
2 properties
Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.ApplicableCategoryViewModel
object
2 properties
Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.VariantViewModelV5
object
26 properties
Products.VariantToMigrate
object
2 properties
Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.AdditionalHazmatAttributesRequestModel
object
8 properties
Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object
object
Products.PackagingRequirementViewModel
object
6 properties
Products.BigCommerceChannelMetadataRequestModel
object
BigCommerce Sales Channel Information with custom Amazon Fields
12 properties
Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.VariantViewModelV5Array
array
Products.FulfillmentSettingsViewModel
object
6 properties
Products.BaseChannelMetadataRequestModel
object
Standard Channel Metadata Record to store SellerSKU for a Sales Channel
10 properties
Products.MergeVariantRequestModel
object
1 property
Products.BigCommerceChannelMetadataViewModel
object
13 properties
Products_deleteProductBundle_Response_200
object
Empty response body
Products.DimensionRequestModel
object
3 properties
Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object
object
ProductsConvertVariantToBundleRequestChannelMetadataItems
Products.LotInformationViewModel
object
2 properties
ProductsVariantViewModelChannelMetadataItems
Products.ReturnPreferencesViewModel
object
5 properties
Products.Get.Api.V5.Product.Bad.Request.Object
object
Products.BaseTaxonomyViewModel
object
3 properties
ProductsVariantViewModelV5ChannelMetadataItems
Products.AdditionalHazmatAttributesViewModel
object
8 properties
Products.ConvertVariantToBundleRequest
object
4 properties
Products.VariantStatus
string
Products.BaseBundleDefinitionModel
object
2 properties
Products.TaxonomyInformationViewModel
object
5 properties
Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails
Products.InventoryViewModel
object
2 properties
Products.VariantInternalViewModel
object
28 properties
Products.CustomsRequestModel
object
5 properties
ProductsBaseProductVariantModelChannelMetadataItems
Products.BundleDefinitionRequestModel
object
2 properties
ProductsBaseProductVariantRequestModelStatusId
string
The status ID of the variant (0 = Active, 1 = Inactive)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shipbob-subpackage-products-api-openapi.yml Raw ↑

Other APIs ShipBob publishes across the network.

ShipBob subpackage_billing API
ShipBob subpackage_channels API
ShipBob subpackage_inventory API
ShipBob subpackage_locations API
ShipBob subpackage_orders API
ShipBob subpackage_receiving API
ShipBob subpackage_returns API
ShipBob subpackage_simulations API
ShipBob subpackage_webhooks API
Where this information came from

This is an independent, third-party profile of ShipBob subpackage_products API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.