ShipBob subpackage_orders 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
22 operations
across 21 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.
Orders.CarrierShipType
string
Orders.RetailerProgramDataViewModel
object
Contains properties that needs to be used for fulfilling B2B/Dropship orders.
9 properties
Orders.ShipMethodDetailViewModel
object
5 properties
Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object
object
Orders.ShipmentAction
string
Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object
object
Orders.RetailerProgramDataAddressViewModel
object
Address to used when creating a B2B/DropShip order.
8 properties
4 required
Orders.PackageMaterialType
string
Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object
object
Orders.LotInfo
object
3 properties
Orders.ChannelInfoViewModel
object
Created by channel metadata
2 properties
Orders.BulkUpdateResponseResult
object
3 properties
Orders.Post.Api.Order.Bad.Request.Object
object
Orders.TagViewModel
object
2 properties
2 required
Orders.SalesChannel
string
Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object
object
Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String
string
Orders.ShipmentLineItemsViewModel
object
7 properties
2 required
Orders.CanceledShipmentViewModel
object
4 properties
Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object
object
Orders.CartonViewModel
object
5 properties
Orders.AddProductToOrderByReferenceIdModel
object
9 properties
3 required
Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object
object
Orders.UpdateLineItemsRequest
object
1 property
1 required
Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object
object
Orders.Get.Api.Order.OrderId.Bad.Request.Object
object
Orders.ShipmentLineItemDetail
object
8 properties
Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object
object
Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object
object
Orders.CartonMeasurementsViewModel
object
Measurements of a carton
4 properties
Orders.CancelShipmentsModel
object
Model for cancel multiple shipments at once
1 property
Orders.ShipmentProductViewModel
object
Information about a store product belonging to a shipment
5 properties
Orders.Financials
object
1 property
Orders.ShipmentLogViewModelArray
array
Orders.Get.Api.Order.Bad.Request.Object
object
Orders.ParentCartonViewModel
object
4 properties
Orders.Get.Api.Shippingmethod.Bad.Request.Object
object
Orders.AddProductToOrderByProductIdModel
object
4 properties
2 required
Orders.RecipientInfoViewModel
object
Information about the recipient of an order
4 properties
2 required
Orders.OrderStatusEnum
string
Orders.ShipmentLogViewModel
object
5 properties
Orders.CanceledOrderViewModel
object
4 properties
Orders.StatusDetailViewModel
object
6 properties
Orders.IApiDetailResponse
object
3 properties
Orders.EstimateViewModel
object
1 property
Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object
object
Orders.BulkUpdateShippingServiceRequest
object
3 properties
3 required
Orders.BulkUpdateTrackingUploadModel
object
Model for updating tracking upload status for multiple shipments
2 properties
Orders.ShipmentLineItemsApiResponse
object
4 properties
Orders.CanceledShipmentsViewModel
object
1 property
Orders.BulkUpdateResponseModel
object
2 properties
Orders.ErrorResponse
object
2 properties
OrdersRecipientInfoViewModelAddress
Address of the recipient
Orders.Post.Api.Order.Unprocessable.Entity.Object
object
Orders.ShippingTermsViewModel
object
Contains shipping properties that need to be used for fulfilling an order.
2 properties
Orders.EstimateFulfillmentRequestModel
object
3 properties
2 required
Orders.StatusInformationViewModel
object
1 property
Orders.Post.Api.Order.Estimate.Bad.Request.Object
object
Orders.ShipMethodDetailViewModelArray
array
Orders.UpdateAddressRequest
object
10 properties
2 required
Orders.OrderStatus
string
Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object
object
Orders.LotSelectionMethod
string
Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray
array
Orders.OrderViewModelArray
array
Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object
object
Orders.SummaryResponse
object
3 properties
Orders.ShipmentLineItemResponse
object
4 properties
Orders.BulkActionApiResponse
object
2 properties
1 required
Orders.EstimateDetailViewModel
object
5 properties
Orders.InventoryViewModel
object
Information about inventory belonging to a store product
8 properties
Orders.OrderViewModel
object
17 properties
Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object
object
Orders.ShipmentViewModel
object
Information about a shipment
26 properties
Orders.ProductVariantDetail
object
3 properties
Orders.CreateOrderModel
object
15 properties
5 required
Orders.FulfillmentCenterViewModel
object
Information about a fulfillment center that a shipment can belong to
2 properties
Orders.AddressType
string
Orders.PaymentShipTerm
string
Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object
object
Orders.AddressViewModel
object
7 properties
3 required
Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object
object
Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object
object
Orders.EstimateProductInfoModel
object
3 properties
1 required
Orders.FulfillmentStatus
string
Orders.EstimationAddressViewModel
object
7 properties
1 required
Orders.ProductInfoViewModel
object
9 properties
Orders.ShipmentLineItemDetailArray
array
OrdersCreateOrderModelProductsItems
Orders.TrackingViewModel
object
Tracking information for a shipment
8 properties
Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String
string
Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object
object
Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object
object
Orders.ServiceLevelDetailViewModel
object
2 properties
Orders.MeasurementsViewModel
object
Measurements of a shipment
4 properties
Orders.BulkUpdateResponseError
object
2 properties
Orders.RecipientViewModel
object
Information about the recipient of a shipment
5 properties
Orders.ShipmentApiResponse
object
3 properties
Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object
object
OrdersRecipientViewModelAddress
Address of the recipient
Orders.BulkUpdateResponseSummary
object
3 properties
Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object
object
Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object
object
Orders.CartonDetailsViewModel
object
1 property
Orders.CancellationResult
string
Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object
object
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ShipBob publishes across the network.
