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.
The identity and technical contract details declared by the specification.
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)
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ShipBob publishes across the network.