{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/2026-07/channel":{"get":{"operationId":"channels_getChannels","summary":"Get Channels","description":"Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.\n","tags":["channels"],"parameters":[{"name":"RecordsPerPage","in":"query","description":"The number of records to return per page. This parameter is used for pagination. If not provided, a default value will be used.","required":false,"schema":{"type":"integer","default":50}},{"name":"Cursor","in":"query","description":"A cursor for pagination. This parameter is used to fetch the next set of results.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.ChannelsV2ViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order":{"post":{"operationId":"orders_createOrder","summary":"Create Order","description":"Creates a new order in ShipBob’s system that will be queued for fulfillment. Orders can be created using either product reference IDs (SKUs) or ShipBob product IDs, with reference IDs being the recommended approach.","tags":["orders"],"parameters":[{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Shipbob.Channel.Id.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Unprocessable.Entity.Object"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CreateOrderModel"}}}},"security":[{"PAT":[]}]},"get":{"operationId":"orders_getOrders","summary":"Get Orders","description":"Retrieves a paginated list of orders from your ShipBob account with optional filters. All filter parameters use AND logic, meaning orders must match all provided criteria to be returned.","tags":["orders"],"parameters":[{"name":"Page","in":"query","description":"Page of orders to get","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Page.Integer"}},{"name":"Limit","in":"query","description":"Amount of orders per page to request","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Limit.Integer"}},{"name":"IDs","in":"query","description":"order ids to filter by, comma separated <br /><strong>Example:</strong> ?IDs=1,2","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.IDs.IntegerArray"}},{"name":"ReferenceIds","in":"query","description":"Reference ids to filter by, comma separated <br /><strong>Example:</strong> ?ReferenceIds=Ref1,Ref2","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.ReferenceIds.StringArray"}},{"name":"StartDate","in":"query","description":"Start date to filter orders inserted later than","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.StartDate.String"}},{"name":"EndDate","in":"query","description":"End date to filter orders inserted earlier than","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.EndDate.String"}},{"name":"SortOrder","in":"query","description":"Order to sort results in","required":false,"schema":{"$ref":"#/components/schemas/Orders.SortOrder"}},{"name":"HasTracking","in":"query","description":"Has any portion of this order been assigned a tracking number","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.HasTracking.Boolean"}},{"name":"LastUpdateStartDate","in":"query","description":"Start date to filter orders updated later than","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastUpdateStartDate.String"}},{"name":"LastUpdateEndDate","in":"query","description":"End date to filter orders updated later than","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastUpdateEndDate.String"}},{"name":"IsTrackingUploaded","in":"query","description":"Filter orders that their tracking information was fully uploaded","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.IsTrackingUploaded.Boolean"}},{"name":"LastTrackingUpdateStartDate","in":"query","description":"Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastTrackingUpdateStartDate.String"}},{"name":"LastTrackingUpdateEndDate","in":"query","description":"End date to filter orders updated later than the supplied date. Will only return orders that have tracking information","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastTrackingUpdateEndDate.String"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}":{"get":{"operationId":"orders_getOrder","summary":"Get Order","description":"Retrieves detailed information about a specific order by its order ID, including order status, shipments, products, and recipient details.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}":{"get":{"operationId":"orders_getShipment","summary":"Get Shipment","description":"Retrieves detailed information about a specific shipment by shipment ID, including shipment status, tracking information, fulfillment center location, and contained products.","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}/timeline":{"get":{"operationId":"orders_getShipmentTimeline","summary":"Get Shipment Timeline","description":"Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment:batchCancel":{"post":{"operationId":"orders_batchCancelShipments","summary":"Batch Cancel Shipments","description":"Cancels multiple shipments in a single request. Shipments can only be cancelled if they are in a cancellable state (i.e. not picked, packed, or shipped yet).","tags":["orders"],"parameters":[{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CanceledShipmentsViewModel"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object"}}}}},"requestBody":{"description":"The shipment IDs to cancel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CancelShipmentsModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment:batchUpdateTrackingUpload":{"post":{"operationId":"orders_markTrackingUploaded","summary":"Mark Tracking Uploaded","description":"Mark tracking information as synced to your external system for multiple shipments. Use this endpoint after syncing tracking data to update the IsTrackingUploaded flag, preventing these shipments from appearing in future GET /order queries with IsTrackingUploaded=false.\n\n<Tip>Use this endpoint if you're filtering orders by is_tracking_uploaded. This allows integrations to acknowledge that shipments have been successfully synced to their system.</Tip>","tags":["orders"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateTrackingUploadModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/order:estimateDeliveryDate":{"post":{"operationId":"orders_estimateDeliveryDate","summary":"Estimate Delivery Date\n","description":"Returns an estimated delivery date for a given destination and set of line items. The destination address must always include `zip_code` and `country`. The flow is auto-detected from the request shape: an address with only `zip_code` and `country` plus exactly one line item is treated as the Product Details Page (PDP) flow; a full address with one or more line items is treated as the Checkout flow.\n","tags":["orders"],"parameters":[{"name":"x_correlation_id","in":"header","description":"Optional caller-supplied correlation id (UUID) echoed back in the response and logs for end-to-end request tracing. If omitted, the request is still processed; supplying one makes it easier to correlate this call across ShipBob systems.\n","required":false,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.X.Correlation.Id.String"}}],"responses":{"200":{"description":"OK: one of: full success (estimates populated, errors empty), partial success (both populated), or system-can't-fulfill (empty estimates + one ApiError in errors[]).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.OK.Object"}}}},"400":{"description":"Bad Request: caller sent a malformed request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found: caller referenced a resource that does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Not.Found.Object"}}}},"422":{"description":"Unprocessable Entity: caller violated a business rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Unprocessable.Entity.Object"}}}},"500":{"description":"Internal Server Error: EDD-internal failure or an unhandled exception.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Internal.Server.Error.Object"}}}},"502":{"description":"Bad Gateway: upstream dependency returned an error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Bad.Gateway.Object"}}}},"504":{"description":"Gateway Timeout: upstream dependency did not respond within the allowed time.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Gateway.Timeout.Object"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Delivery.Date.Request.Object"}}}},"security":[{"PAT":[]}]}},"/2026-07/order:estimate":{"post":{"operationId":"orders_estimateFulfillmentCostForOrder","summary":"Estimate Fulfillment Cost For Order","description":"This endpoint will provide, where possible, an estimate of pricing and fulfillment center assignment of a potential standard (direct to consumer) order. Keep in mind that there are ways for the merchant to change FC assignment or product configuration after order creation that could invalidate this estimate. Estimates cannot be returned for items that are unknown, out of stock, or too large for fulfillment using standard box sizes. Additional services such as high-pick fees, shipping insurance, auto-splitting or auto-adding items to orders, and signature required are not included in this estimate.","tags":["orders"],"parameters":[{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateFulfillmentRequestModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}:updateAddress":{"put":{"operationId":"orders_updateShipmentAddress","summary":"Update Shipment Address\n","description":"Updates the shipping address for a specific shipment.\n","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"Unique identifier of the shipment","required":true,"schema":{"$ref":"#/components/schemas/Orders.Put.Api.V.Version.Shipment.ShipmentId.UpdateAddress.ShipmentId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateAddressRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}:getLineItems":{"get":{"operationId":"orders_getShipmentLineItems","summary":"Get Shipment Line Items\n","description":"Retrieves the current line items for a specific shipment, including product variant details, lot information, committed quantities, and serial numbers. Use this endpoint to get the current state before calling updateLineItems, which requires the full item list.\n","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"Unique identifier of the shipment","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.V.Version.Shipment.ShipmentId.GetLineItems.ShipmentId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLineItemDetailArray"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}:updateLineItems":{"post":{"operationId":"orders_updateShipmentLineItems","summary":"Update Shipment Line Items\n","description":"Updates the line items for a specific shipment. The request body must include the complete list of line items as returned by the GET /shipment/{shipmentId}:getLineItems endpoint — partial updates are not supported. Retrieve the current line items first, modify the desired fields, and submit the full payload.\n\n**Important:** The `is_manually_assigned_lot` field must be set to the same value for all line items in the request. When set to `true` on any item, ShipBob treats all lot assignments in the shipment as manually reviewed — ShipBob will not auto-assign or re-optimize lots for any item. When set to `false`, ShipBob manages lot selection automatically. Mixing `true` and `false` across items in the same request will result in a validation error.\n\n**Note on error handling:** This endpoint returns HTTP 200 for both successful and failed operations. Always check the `is_success` field in the response body to determine the outcome. When `is_success` is `false`, the `error` object contains the error code and message. HTTP 400 is only returned when the request body itself is missing or empty.\n","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"Unique identifier of the shipment","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.V.Version.Shipment.ShipmentId.UpdateLineItems.ShipmentId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLineItemsApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateLineItemsRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}:updateLineItemsBySku":{"post":{"operationId":"orders_updateShipmentLineItemsBySku","summary":"Update Shipment Line Items by SKU\n","description":"Updates the line items for a specific shipment, identifying each item by SKU instead of inventory id. The SKU matches both the ShipBob variant SKU and the channel seller SKU. The request body must include the complete list of line items — partial updates are not supported. Retrieve the current line items first (via GET /shipment/{shipmentId}:getLineItems, which returns each item's `product_variant.sku`), modify the desired fields, and submit the full payload.\n\n**SKU resolution:** Resolution is all-or-nothing — if any SKU in the request cannot be resolved, the whole request fails and no update occurs. A SKU that resolves to a bundle or to multiple inventory items is rejected with a per-item error; use the inventory_id-based endpoint (:updateLineItems) for those items.\n\n**Important:** The `is_manually_assigned_lot` field must be set to the same value for all line items in the request. When set to `true` on any item, ShipBob treats all lot assignments in the shipment as manually reviewed — ShipBob will not auto-assign or re-optimize lots for any item. When set to `false`, ShipBob manages lot selection automatically. Mixing `true` and `false` across items in the same request will result in a validation error.\n\n**Note on error handling:** This endpoint returns HTTP 200 for both successful and failed operations. Always check the `is_success` field in the response body to determine the outcome. When `is_success` is `false`, the `error` object contains the error code and message. HTTP 400 is only returned when the request body itself is missing or empty.\n","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"Unique identifier of the shipment","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.V.Version.Shipment.ShipmentId.UpdateLineItemsBySku.ShipmentId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLineItemsApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateLineItemsBySkuRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}:assignFulfillmentCenter":{"post":{"operationId":"orders_assignFulfillmentCenter","summary":"Assign Fulfillment Center\n","description":"Assigns a specific fulfillment center to a shipment, overriding the automatically selected one. The caller must have access to the target fulfillment center.\n\n**Important — asynchronous inventory re-evaluation:** This action does NOT pre-check inventory availability at the target fulfillment center. The assignment succeeds immediately and inventory allocation re-evaluates the shipment asynchronously; if stock is missing at the target FC the shipment may land in an exception state. It also does not revalidate that the target fulfillment center supports the shipment's current shipping service. Both behaviors mirror the merchant dashboard.\n\n**Validation:** The action is rejected when the shipment is already picked, being picked, or sorted by the warehouse; cancelled; shipped or completed; a Kitting shipment; an Automated Amazon FBA shipment; or when the target fulfillment center is inactive or not accessible to the caller.\n\n**Note on error handling:** This endpoint returns HTTP 200 for both successful and failed operations. Always check the `is_success` field in the response body; when `is_success` is `false`, the `error` object contains the code and message. HTTP 400 is only returned when the request body itself is missing (null); a missing or non-positive `fulfillment_center_id` is returned as HTTP 200 with `is_success: false`.\n","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"Unique identifier of the shipment","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.V.Version.Shipment.ShipmentId.AssignFulfillmentCenter.ShipmentId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.AssignFulfillmentCenterRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment:bulkUpdateShippingService":{"put":{"operationId":"orders_bulkUpdateShippingService","summary":"Bulk Update Shipping Service\n","description":"Updates the shipping service for multiple shipments in a single request. The `requested_shipping_service_id` corresponds to the `service_level.id` value returned by the [Get Shipping Methods](/api/orders/get-shipping-methods) endpoint.\n","tags":["orders"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkActionApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateShippingServiceRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment:bulkPlaceOnHold":{"post":{"operationId":"orders_bulkPlaceShipmentsOnHold","summary":"Bulk Place Shipments On Hold\n","description":"Places a Manual hold on multiple shipments in a single request. By default the committed inventory stays reserved and an allocation hold is placed; set `reserve_inventory` to `false` to deallocate the committed inventory instead (mirrors the dashboard's \"Unreserve\" option).\n\n**Per-shipment results:** every shipment is evaluated independently and returns its own success/failure in `results`; one shipment failing never fails the whole request. A shipment already on a Manual hold is an idempotent success. Shipments that are picked, being fulfilled, cancelled, shipped, or otherwise ineligible fail individually. HTTP 400 is only returned when the request itself is malformed (empty `shipment_ids` or over the batch cap).\n","tags":["orders"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkActionApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkPlaceOnHoldRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment:bulkReleaseHold":{"post":{"operationId":"orders_bulkReleaseShipmentsFromHold","summary":"Bulk Release Shipments From Hold\n","description":"Releases multiple shipments from hold in a single request. Only the merchant-initiated holds — Manual and Auto Processing Pause — are removed; operational holds (e.g. invalid address, short at pack) are never removed by this action.\n\n**Per-shipment results:** each shipment returns its own result in `results`. A shipment moves back to processing only when no hold reasons of any kind remain after the merchant-initiated holds are removed. If the shipment stays held for operational reasons, the release still succeeds and `is_still_on_hold_due_to_other_reasons` is `true`. Releasing a shipment with nothing to release is an idempotent success. HTTP 400 is only returned when the request itself is malformed (empty `shipment_ids` or over the batch cap).\n","tags":["orders"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ReleaseHoldBulkActionApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkReleaseHoldRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}:cancel":{"post":{"operationId":"orders_cancelOrder","summary":"Cancel Order","description":"Cancels an order and all associated shipments. The order must be in a cancellable state to proceed with the cancellation.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"The order ID to cancel","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CanceledOrderViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}:cancel":{"post":{"operationId":"orders_cancelShipment","summary":"Cancel Shipment","description":"Cancels a specific shipment by shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipping-method":{"get":{"operationId":"orders_getShippingMethods","summary":"Get Shipping Methods","description":"Retrieves all available shipping methods configured for your merchant account.","tags":["orders"],"parameters":[{"name":"Page","in":"query","description":"Page of orders to get","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Page.Integer"}},{"name":"Limit","in":"query","description":"Amount of records per page to request","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Limit.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipMethodDetailViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}/shipment/{shipmentId}/timeline":{"get":{"operationId":"orders_getShipmentStatusTimelineByOrderIdAndShipmentId","summary":"Get Shipment Status Timeline by Order ID and Shipment ID","description":"Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"The order id to get the shipment for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.OrderId.Integer"}},{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}/shipment":{"get":{"operationId":"orders_getAllShipmentsForOrder","summary":"Get All Shipments for Order","description":"Retrieves all shipments associated with a specific order, including shipment status, tracking information, and product details.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"The order id to get shipments for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}/shipment/{shipmentId}/logs":{"get":{"operationId":"orders_getShipmentLogsByOrderIdAndShipmentId","summary":"Get Shipment Logs by Order ID and Shipment ID","description":"Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"The order id to get the shipment for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.OrderId.Integer"}},{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.ShipmentId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}/shipment/{shipmentId}:cancel":{"post":{"operationId":"orders_cancelShipmentByOrderIdAndShipmentId","summary":"Cancel Shipment by Order ID and Shipment ID","description":"Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.ShipmentId.Integer"}},{"name":"orderId","in":"path","description":"The order ID the shipment belongs to","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment/{shipmentId}/logs":{"get":{"operationId":"orders_getShipmentLogs","summary":"Get Shipment Logs","description":"Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.","tags":["orders"],"parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}/shipment/{shipmentId}":{"get":{"operationId":"orders_getShipmentByOrderIdAndShipmentId","summary":"Get Shipment by Order ID and Shipment ID","description":"Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"The order id to get the shipment for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OrderId.Integer"}},{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"The id of the sales channel the request runs under, as returned by GET /channel.","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/{orderId}/store-order-json":{"get":{"operationId":"orders_getOrderStoreData","summary":"Get Order Store Data","description":"Retrieves the original store order data associated with the order in JSON format, preserving custom fields and metadata from the order source.","tags":["orders"],"parameters":[{"name":"orderId","in":"path","description":"The order ID to Get the JSON Stored","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.OrderId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object"}}}}},"security":[{"PAT":[]}]}},"/2026-07/order/cancelled":{"get":{"operationId":"orders_getCompletelyCancelledOrders","summary":"Get Completely Cancelled Orders","description":"Retrieve the IDs of orders and their associated shipments that have been fully cancelled, meaning all shipments within the order are in a cancelled state.","tags":["orders"],"parameters":[{"name":"Page","in":"query","description":"Page of orders to get","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Cancelled.Page.Integer"}},{"name":"Limit","in":"query","description":"Amount of orders per page to request","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Cancelled.Limit.Integer"}},{"name":"IsTrackingUploaded","in":"query","description":"Indicates whether the Shipment was marked with tracking information uploaded to a third-party system where the order originated","required":false,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Cancelled.IsTrackingUploaded.Boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderShipmentIdsViewModelArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Cancelled.Bad.Request.Object"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipment:bulkUpdateInstructions":{"put":{"operationId":"orders_bulkUpdateInstructions","summary":"Bulk Update Instructions\n","description":"Sets the packing instructions and/or special SKU instructions on multiple shipments in a single request.\n\nEach instruction field is optional, and omitting a field is different from sending an empty one:\n\n- **Omit** the field, or send `null`, to leave that instruction unchanged.\n- Send an **empty string** to clear that instruction.\n\nAt least one of the two must be provided with a **non-null** value — a request that omits both, or sends `null` for both, is rejected with `400 INVALID_PARAMETER`. `{\"packing_instruction\": null}` counts as providing nothing.\n\nEach value is limited to 500 characters, measured **after** leading and trailing whitespace is removed. Whitespace padding around a 500-character instruction is therefore accepted.\n\n`shipment_ids` is de-duplicated before the 250-shipment maximum is applied, and the response contains one result per unique id, in request order.\n\nInstructions apply to B2B, SPS B2B, drop ship, kitting and inventory transfer shipments (including Amazon FBA). Direct-to-consumer shipments do not carry packing or SKU instructions.\n\nInstructions can only be changed while a shipment is still editable. A shipment whose order type does not support instructions, that has been cancelled, cleanswept, shipped or completed, or that has already been assigned a tracking number, is reported as a per-shipment `BUSINESS_RULE_VIOLATION` rather than failing the whole request. A shipment that does not exist, or that belongs to another merchant, is reported as `NOT_FOUND`.\n\nSubmitting a value a shipment already has is a successful no-op: nothing is written and no audit entry is recorded.\n","tags":["orders"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkActionApiResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateInstructionsRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/product":{"post":{"operationId":"products_createProduct","summary":"Create Product","description":"Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.","tags":["products"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV8"}}}}},"requestBody":{"description":"The product to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductRequestModelV8"}}}},"security":[{"PAT":[]}]},"get":{"operationId":"products_getProducts","summary":"Get Products","description":"Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.","tags":["products"],"parameters":[{"name":"Search","in":"query","description":"Search Products by name, sku, inventory id or product Id.\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Search.String"}},{"name":"Barcode","in":"query","description":"Barcode Associated with variant\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Barcode.Int"}},{"name":"Barcodes","in":"query","description":"Barcodes Associated with variant\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Barcodes.List.String"}},{"name":"CategoryIds","in":"query","description":"List of Category Ids associated with product\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.CategoryIds.List.Int"}},{"name":"ChannelIds","in":"query","description":"Looks for Products variants by their channel IDs\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ChannelIds.List.Int"}},{"name":"HasDigitalVariants","in":"query","description":"Looks for Products with/without digital variants\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.HasDigitalVariants.Boolean"}},{"name":"HasVariants","in":"query","description":"Looks for Products with/without variants\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.HasVariants.Boolean"}},{"name":"InventoryId","in":"query","description":"Looks for variants by its associated inventory id\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.InventoryId.List.Int"}},{"name":"IsInventorySyncEnabled","in":"query","description":"Looks for Products variants by their IsInventorySyncEnabled is true\n","required":false,"schema":{"$ref":"#/components/schemas/202607ProductGetParametersIsInventorySyncEnabled"}},{"name":"LastUpdatedTimestamp","in":"query","description":"Looks for Products that have been updated since the given date\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.LastUpdatedTimestamp.DateTime"}},{"name":"LegacyIds","in":"query","description":"Looks for Products with by Legacy Product Id(s)\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.LegacyIds.List.Int"}},{"name":"Name","in":"query","description":"Looks for Products/Variants by name\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Name.String"}},{"name":"OnHand","in":"query","description":"Looks for Products with inventory\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.OnHand.Integer"}},{"name":"PlatformIds","in":"query","description":"Looks for Products variants by their external Platform IDs\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.PlatformIds.List.String"}},{"name":"ProductId","in":"query","description":"Looks for Products with an assigned Id\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.List.Int"}},{"name":"ProductType","in":"query","description":"Looks for Products by type\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductType.Integer"}},{"name":"ReviewsPending","in":"query","description":"Looks for Products by ReviewsPending\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ReviewsPending.List.ReviewsPendingType"}},{"name":"SalesChannel","in":"query","description":"Looks for Products variants assigned to a platform/sales channel \n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.SalesChannel.List.String"}},{"name":"SellerSKU","in":"query","description":"Looks for Products that match the provided Seller query\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.SellerSKU.String"}},{"name":"SKU","in":"query","description":"Looks for Products that match the provided Sku query\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.SKU.String"}},{"name":"TaxonomyIds","in":"query","description":"Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.TaxonomyIds.List.Int"}},{"name":"VariantId","in":"query","description":"Looks for products that contain a variant with the given ID\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.VariantId.List.Int"}},{"name":"VariantStatus","in":"query","description":"Looks for Products with variants that contain provided status\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.VariantStatus.String"}},{"name":"PageSize","in":"query","description":"1-250\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.PageSize.Int"}},{"name":"SortBy","in":"query","description":"Id, Name, Category, TotalOnHandQty\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.SortBy.String"}},{"name":"SortOrder","in":"query","description":"ASC,DESC\n","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.SortOrder.String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV8PagedResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Bad.Request.Object"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/product/{productId}":{"get":{"operationId":"products_getProduct","summary":"Get Product","description":"Retrieves a product with all its variants and details.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"The ShipBob product id, as returned in the id field by GET /product.\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV8"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Bad.Request.Object"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}}},"security":[{"PAT":[]}]},"patch":{"operationId":"products_updateProduct","summary":"Update Product","description":"Updates a product. Supports partial updates - only the fields provided will be updated. When updating variants through this endpoint, you must include the variant ID.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"The product identifier\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Patch.Api.V5.Product.ProductId.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV8"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.UpdateProductRequestModelV8"}}}},"security":[{"PAT":[]}]},"delete":{"operationId":"products_deleteProductBundle","summary":"Delete Product Bundle","description":"Deletes a bundle product by ID. Delete operation not allowed for non-bundles.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"The product identifier\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Delete.Api.V5.Product.ProductId.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products_deleteProductBundle_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/product/{productId}/variants":{"get":{"operationId":"products_getProductVariants","summary":"Get Product Variants","description":"Retrieves all variants for a specific product.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"The product id\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Variants.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModelV8Array"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}}},"security":[{"PAT":[]}]},"post":{"operationId":"products_addProductVariants","summary":"Add Product Variants","description":"Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.Variants.ProductId.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV8"}}}}},"requestBody":{"description":"The product variants to add to product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV8Array"}}}},"security":[{"PAT":[]}]},"patch":{"operationId":"products_updateProductVariants","summary":"Update Product Variants","description":"Updates one or more product variants. The request body must be an array of variant objects. Each variant must include the variant ID, and only the fields provided will be updated.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Patch.Api.V5.Product.ProductId.Variants.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModelV8Array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.UpdateProductVariantModelV8"}}}},"security":[{"PAT":[]}]}},"/2026-07/variant/{variantId}:merge":{"post":{"operationId":"products_mergeVariants","summary":"Merge Variants","description":"Merges multiple product variants into a target variant. Provide an array of variant IDs to merge into the target variant specified in the path. Inventory from the merged variants will be consolidated into the target variant.","tags":["products"],"parameters":[{"name":"variantId","in":"path","description":"The ID of the variant to use as the merge target\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Variant.VariantId.Merge.VariantId.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"}}}}},"requestBody":{"description":"The variants that should be merged to the target variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.MergeVariantRequestModelArray"}}}},"security":[{"PAT":[]}]}},"/2026-07/product/{productId}:moveVariants":{"post":{"operationId":"products_moveVariantsBetweenProducts","summary":"Move Variants Between Products","description":"Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.","tags":["products"],"parameters":[{"name":"productId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.ProductId.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}}},"requestBody":{"description":"Migration definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.MigrateVariantRequestModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/product:moveVariants":{"post":{"operationId":"products_moveVariantsToNewProduct","summary":"Move Variants to New Product","description":"Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.","tags":["products"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}}},"requestBody":{"description":"Migration definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.MigrateVariantRequestModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/packaging-requirement":{"get":{"operationId":"products_getPackagingRequirement","summary":"Get Packaging Requirement","description":"Retrieves all available packaging requirements that can be assigned to a product.","tags":["products"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.PackagingRequirementViewModelArray"}}}}},"security":[{"PAT":[]}]}},"/2026-07/taxonomy":{"get":{"operationId":"products_getTaxonomies","summary":"Get Taxonomies","description":"Retrieves all available product taxonomies for categorizing products.","tags":["products"],"parameters":[{"name":"search","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Search.String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.TaxonomyViewModelArray"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/taxonomy/{id}":{"get":{"operationId":"products_getTaxonomyById","summary":"Get Taxonomy by ID","description":"Retrieves a specific taxonomy node and its details by taxonomy ID.","tags":["products"],"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/taxonomy/{id}/parent":{"get":{"operationId":"products_getTaxonomyParent","summary":"Get Taxonomy Parent","description":"Retrieves the parent taxonomy node for a given taxonomy ID.","tags":["products"],"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/variant/{variantId}:convertToBundle":{"post":{"operationId":"products_convertVariantToBundle","summary":"Convert Variant to Bundle","description":"Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.","tags":["products"],"parameters":[{"name":"variantId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Variant.VariantId.ConvertToBundle.VariantId.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"}}}}},"requestBody":{"description":"The variant request that is to be converted to bundle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ConvertVariantToBundleRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/allergens":{"get":{"operationId":"products_getAllergens","summary":"Get Allergens","description":"Retrieves the list of supported allergens that can be associated with a product variant.","tags":["products"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.AllergenViewModelArray"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory-level":{"get":{"operationId":"inventory_getAllInventoryLevels","summary":"    Get All Inventory Levels\n","description":"    Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes. Use this endpoint for current or real-time stock questions, for example what is in stock or out of stock right now.\n","tags":["inventory"],"parameters":[{"name":"SearchBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.SearchBy.String"}},{"name":"InventoryIds","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.InventoryIds.IntegerArray"}},{"name":"IsActive","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.IsActive.Boolean"}},{"name":"IsDigital","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.IsDigital.Boolean"}},{"name":"has_quarantine","in":"query","description":"","required":false,"schema":{"type":"boolean"}},{"name":"PageSize","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.SortBy.String"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityV4ResponsePagedResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory-level/{inventoryId}":{"get":{"operationId":"inventory_getInventoryLevels","summary":"    Get Inventory Levels\n","description":"    Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types. Use this endpoint to answer how much stock or how many fulfillable units of an item are available.\n","tags":["inventory"],"parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.InventoryId.InventoryId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityV4Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory/{inventoryId}":{"get":{"operationId":"inventory_getInventory","summary":"Get Inventory","description":"Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata. Returns the item record (attributes, variants, and configuration), not stock quantities; for the item's stock quantities (on-hand, committed, fulfillable) use the inventory levels by ID endpoint (GET /inventory-level/{inventoryId}).","tags":["inventory"],"parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory":{"get":{"operationId":"inventory_getAllInventories","summary":"Get All Inventories","description":"Retrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results. Returns the inventory item catalog (item records and their attributes), not stock quantities; for current stock counts use the inventory levels endpoint (GET /inventory-level).","tags":["inventory"],"parameters":[{"name":"SearchBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.SearchBy.String"}},{"name":"FilterOperations","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.FilterOperationArray"}},{"name":"InventoryIds","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.InventoryIds.IntegerArray"}},{"name":"IsActive","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.IsActive.Boolean"}},{"name":"IsDigital","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.IsDigital.Boolean"}},{"name":"PageSize","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V3.Inventories.SortBy.String"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryResponsePagedResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory/history:query":{"post":{"operationId":"inventory_queryInventoryHistoryEvents","summary":"Query Inventory History Events","description":"Fetches inventory movement events that change on-hand quantities within the ShipBob network. Returns events such as receiving/stow, order picks, adjustments, restocks, and attribute updates. Filter by inventory IDs, event category, date range, and facility. Supports cursor-based pagination for large result sets.","tags":["inventory"],"parameters":[{"name":"cursor","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Post.Inventory.History.Query.Cursor.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.MerchantHistoryRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory-level/locations":{"get":{"operationId":"inventory_getAllInventoryLevelsGroupedByFulfillmentCenter","summary":"    Get All Inventory Levels Grouped By Fulfillment Center\n","description":"    Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes. Returns inventory quantities broken down by fulfillment center location; it does not return the list of fulfillment centers. For the physical location list use the Locations API, and for receiving-eligible fulfillment centers use the Receiving API's fulfillment centers endpoint.\n","tags":["inventory"],"parameters":[{"name":"LocationType","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationType.String"}},{"name":"LocationId","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationId.Integer"}},{"name":"SearchBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.SearchBy.String"}},{"name":"InventoryIds","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.InventoryIds.IntegerArray"}},{"name":"IsActive","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.IsActive.Boolean"}},{"name":"IsDigital","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.IsDigital.Boolean"}},{"name":"has_quarantine","in":"query","description":"","required":false,"schema":{"type":"boolean"}},{"name":"PageSize","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Locations.SortBy.String"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcV4ResponsePagedResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory-level/{inventoryId}/locations":{"get":{"operationId":"inventory_getInventoryLevelsGroupedByFulfillmentCenter","summary":"    Get Inventory Levels Grouped By Fulfillment Center\n","description":"   \tRetrieves inventory levels for a specific inventory item broken down by fulfillment center location. Shows quantity breakdowns for each location where the inventory is stored.\n","tags":["inventory"],"parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Locations.InventoryId.Integer"}},{"name":"has_quarantine","in":"query","description":"","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcV4Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory-level/lots":{"get":{"operationId":"inventory_getAllInventoryLevelsGroupedByLot","summary":"    Get All Inventory Levels Grouped By Lot\n","description":"    Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.\n","tags":["inventory"],"parameters":[{"name":"LocationId","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.LocationId.Integer"}},{"name":"SearchBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.SearchBy.String"}},{"name":"InventoryIds","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.InventoryIds.IntegerArray"}},{"name":"IsActive","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.IsActive.Boolean"}},{"name":"IsDigital","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.IsDigital.Boolean"}},{"name":"has_quarantine","in":"query","description":"","required":false,"schema":{"type":"boolean"}},{"name":"PageSize","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.Lots.SortBy.String"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotV4ResponsePagedResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/inventory-level/{inventoryId}/lots":{"get":{"operationId":"inventory_getInventoryLevelsGroupedByLot","summary":"    Get Inventory Levels Grouped By Lot\n","description":"    Retrieves inventory levels for a specific inventory item broken down by lot number. Useful for tracking inventory by manufacturing lot, expiration date, or batch information.\n","tags":["inventory"],"parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Lots.InventoryId.Integer"}},{"name":"has_quarantine","in":"query","description":"","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotV4Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/lot-exclusion":{"get":{"operationId":"inventory_getLotExclusions","summary":"    Get Lot Exclusions\n","description":"    Retrieves lot exclusions for a specific inventory item. Filter by SKU or inventory ID to find which lots are excluded from fulfillment.\n","tags":["inventory"],"parameters":[{"name":"sku","in":"query","description":"SKU of the inventory item to retrieve lot exclusions for\n","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Lot.Exclusions.Sku.String"}},{"name":"inventory_id","in":"query","description":"Unique identifier of the inventory item to retrieve lot exclusions for\n","required":false,"schema":{"$ref":"#/components/schemas/Inventory.Get.Api.V4.Lot.Exclusions.InventoryId.Integer"}}],"responses":{"200":{"description":"Successfully retrieved lot exclusions for the inventory item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.LotExclusionsResponse"}}}},"400":{"description":"Invalid request, either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Inventory item not found for the given sku or inventory_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]},"post":{"operationId":"inventory_createLotExclusion","summary":"    Create Lot Exclusion\n","description":"    Creates a new lot exclusion for a specific inventory item. Excludes a lot number from being fulfilled for the given inventory.\n","tags":["inventory"],"responses":{"201":{"description":"Lot exclusion successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.CreateLotExclusionResponse"}}}},"400":{"description":"Invalid request, lot_number is required and either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Inventory item not found for the given sku or inventory_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"409":{"description":"A lot exclusion already exists for the given inventory item and lot number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.Post.Api.V4.Lot.Exclusions.CreateLotExclusionRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/lot-exclusion/restore":{"post":{"operationId":"inventory_restoreLotExclusion","summary":"    Restore Lot Exclusion\n","description":"    Restores a previously deleted lot exclusion for a specific inventory item. Reverses a soft-delete operation.\n","tags":["inventory"],"responses":{"200":{"description":"Lot exclusion successfully restored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.RestoreLotExclusionResponse"}}}},"400":{"description":"Invalid request, lot_number is required and either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Lot exclusion not found for the given inventory item and lot number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.Post.Api.V4.Lot.Exclusions.Restore.RestoreLotExclusionRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/lot-exclusion:delete":{"post":{"operationId":"inventory_deleteLotExclusion","summary":"    Delete Lot Exclusion\n","description":"    Soft-deletes a lot exclusion for a specific inventory item. The exclusion can be restored later using the restore endpoint.\n","tags":["inventory"],"responses":{"200":{"description":"Lot exclusion successfully soft-deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.DeleteLotExclusionResponse"}}}},"400":{"description":"Invalid request, lot_number is required and either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"404":{"description":"Lot exclusion not found for the given inventory item and lot number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.Post.Api.V4.Lot.Exclusions.Delete.DeleteLotExclusionRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving":{"post":{"operationId":"receiving_createWarehouseReceivingOrder","summary":"Create Warehouse Receiving Order\n","tags":["receiving"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.WarehouseReceivingOrderViewModel"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}},"422":{"description":"Unprocessable Content. Validation errors are returned keyed by field; business-rule errors that are not tied to a specific field are returned under an empty key. A receiving order referencing more than 10,000 unique inventory items (SKUs) across all of its boxes is rejected here with the WRO_UNIQUE_SKU_LIMIT_EXCEEDED reason code; the message includes the submitted and maximum counts so the request can be split.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.3.0.Receiving.Unprocessable.Entity.Object"}}}}},"requestBody":{"description":"The receiving order to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.CreateReceivingOrderV3Model"}}}},"security":[{"PAT":[]}]},"get":{"operationId":"receiving_getMultipleWarehouseReceivingOrders","summary":"Get Multiple Warehouse Receiving Orders\n","description":"Returns a list of warehouse receiving orders with optional filtering by status, fulfillment center, purchase order number, and date range.\n","tags":["receiving"],"parameters":[{"name":"Page","in":"query","description":"Page of WROs to get\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Page.Integer"}},{"name":"Limit","in":"query","description":"Number of WROs per page to request\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Limit.Integer"}},{"name":"IDs","in":"query","description":"Comma separated list of WRO IDs to filter by\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.IDs.IntegerArray"}},{"name":"Statuses","in":"query","description":"Comma separated list of WRO statuses to filter by\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.ReceivingStatusArray"}},{"name":"InsertStartDate","in":"query","description":"Earliest date that a WRO was created\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.InsertStartDate.String"}},{"name":"InsertEndDate","in":"query","description":"Latest date that a WRO was created\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.InsertEndDate.String"}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma separated list of WRO fulfillment center IDs to filter by\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.FulfillmentCenterIds.IntegerArray"}},{"name":"PurchaseOrderNumbers","in":"query","description":"Comma separated list of WRO PO numbers to filter by\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.PurchaseOrderNumbers.StringArray"}},{"name":"ExternalSync","in":"query","description":"Flag to return external_sync_timestamp WROs\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.ExternalSync.Boolean"}},{"name":"CompletedStartDate","in":"query","description":"Earliest date that a WRO was completed\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.CompletedStartDate.String"}},{"name":"CompletedEndDate","in":"query","description":"Latest date that a WRO was completed\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.CompletedEndDate.String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModelArray"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving/{id}":{"get":{"operationId":"receiving_getWarehouseReceivingOrder","summary":"Get Warehouse Receiving Order\n","description":"Returns details of a specific warehouse receiving order by ID, including its status and the expected, received, and stowed quantities of each SKU in the order. The per-box breakdown of contents is returned by the boxes endpoint.\n","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.3.0.Receiving.Id.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.WarehouseReceivingOrderViewModel"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}}},"security":[{"PAT":[]}]},"patch":{"operationId":"receiving_updateWarehouseReceivingOrder","summary":"Update Warehouse Receiving Order\n","description":"Updates an existing warehouse receiving order. Only the fields included in the request body are changed; omit a field to leave it as it is. The fulfillment center, expected arrival date and boxes can only be changed while the order is awaiting arrival and none of its boxes have started processing, and not once ShipBob shipping labels have been purchased or generated for it. The purchase order number can be changed in any status except complete. Supplying boxes replaces the entire set of boxes and their contents, so send the complete set rather than only the ones that changed.\n","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Patch.3.0.Receiving.Id.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.WarehouseReceivingOrderViewModel"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}},"422":{"description":"Unprocessable Content. Validation errors are returned keyed by field; business-rule errors that are not tied to a specific field are returned under an empty key. Changing the fulfillment center, expected arrival date or boxes is rejected here once the order has left Awaiting Arrival, once any of its boxes has started processing, once ShipBob shipping labels have been purchased or generated for it, once an unidentified receiving order has been linked to it, or when the order was created by an internal inventory transfer. A request that only changes the purchase order number is still accepted in all of those cases, and is rejected only once the order is complete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Patch.3.0.Receiving.Id.Unprocessable.Entity.Object"}}}}},"requestBody":{"description":"The changes to apply. Omit a field to leave it unchanged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.PatchReceivingOrderV3Model"}}}},"security":[{"PAT":[]}]}},"/2026-07/fulfillment-center":{"get":{"operationId":"receiving_getFulfillmentCenters","summary":"Get Fulfillment Centers\n","description":"Returns the list of ShipBob fulfillment centers that are enabled for receiving inventory. Use this list to choose the destination fulfillment center when creating a warehouse receiving order (WRO). For the full network of ShipBob physical locations regardless of receiving eligibility, use the Locations API.\n","tags":["receiving"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModelArray"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving/{id}/boxes":{"get":{"operationId":"receiving_getWarehouseReceivingOrderBoxes","summary":"Get Warehouse Receiving Order Boxes\n","description":"Returns the boxes in a specific warehouse receiving order and the line items in each box, including quantities, lot information, and inventory IDs. Use this endpoint for the per-box breakdown of a receiving order's contents; totals per SKU are returned by the receiving order details endpoint.\n","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Boxes.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.BoxViewModelArray"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving/{id}/labels":{"get":{"operationId":"receiving_getWarehouseReceivingOrderBoxLabels","summary":"Get Warehouse Receiving Order Box Labels\n","description":"Returns a PDF containing box labels for a specific warehouse receiving order.\n","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving_getWarehouseReceivingOrderBoxLabels_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving/{id}:cancel":{"post":{"operationId":"receiving_cancelWarehouseReceivingOrder","summary":"Cancel Warehouse Receiving Order\n","description":"Cancels an existing warehouse receiving order. Only orders in certain statuses can be cancelled.\n","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order to cancel","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Id.Cancel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object"}}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving:setExternalSync":{"post":{"operationId":"receiving_setExternalSyncFlagForWros","summary":"Set ExternalSync flag for Wros\n","description":"Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.\n","tags":["receiving"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Set.External.Sync.Bad.Request.Object"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"The list of wro ids and a flag to enable external sync","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.UpdateExternalSyncModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving/{id}/distributions":{"get":{"operationId":"receiving_getInventoryDistributionsByWroId","summary":"Get Inventory Distributions by WRO ID","description":"Retrieves the distribution details for a specific receiving order within ShipBob's Inventory Placement Program (IPP).\n<Warning>This endpoint is available only to accounts enrolled in ShipBob's Inventory Placement Program (IPP).</Warning>","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.Receiving.Id.Distributions.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.WroDistributionDetailsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/unidentified-receiving-order":{"get":{"operationId":"receiving_getUnidentifiedReceivingOrders","summary":"Get Unidentified Receiving Orders\n","description":"Returns a list of unidentified receiving orders (UROs) for the merchant, including, when linked, the WRO id and WRO box number (linked_wro_id, linked_wro_box_number). Use isCompleted to filter to UROs that are not yet linked to a WRO (false, default) or that are linked (true). Up to 50 records are returned per page.\n","tags":["receiving"],"parameters":[{"name":"isCompleted","in":"query","description":"When false (default) returns UROs not yet linked to a WRO; when true returns UROs linked to a WRO.\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.3.0.UnidentifiedReceivingOrder.IsCompleted.Boolean"}},{"name":"page","in":"query","description":"1-based page number. Up to 50 records are returned per page.\n","required":false,"schema":{"$ref":"#/components/schemas/Receiving.Get.3.0.UnidentifiedReceivingOrder.Page.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.UnidentifiedReceivingOrderViewModelArray"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/unidentified-receiving-order/{uroId}":{"get":{"operationId":"receiving_getUnidentifiedReceivingOrder","summary":"Get Unidentified Receiving Order\n","description":"Returns a single unidentified receiving order (URO) owned by the merchant, including its attachments and, when linked, the WRO id and WRO box number (linked_wro_id, linked_wro_box_number). Responds 404 if the URO does not exist or belongs to another merchant.\n","tags":["receiving"],"parameters":[{"name":"uroId","in":"path","description":"Id of the unidentified receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.3.0.UnidentifiedReceivingOrder.Uroid.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.UnidentifiedReceivingOrderViewModel"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/unidentified-receiving-order/{uroId}:associateWRO":{"post":{"operationId":"receiving_associateUnidentifiedReceivingOrderWithWro","summary":"Associate Unidentified Receiving Order with WRO\n","description":"Links an unidentified receiving order to a specific box of a warehouse receiving order owned by the merchant. Both wro_id and box_number are required.\n","tags":["receiving"],"parameters":[{"name":"uroId","in":"path","description":"Id of the unidentified receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Post.3.0.UnidentifiedReceivingOrder.AssociateWRO.Uroid.Integer"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}},"422":{"description":"Unprocessable Content. Validation errors are returned keyed by field (for example a missing or non-positive wro_id or box_number); business-rule errors not tied to a specific field are returned under an empty key (e.g. \"URO xx is already linked to WRO X\", \"URO xx not found\", \"WRO xx not found\", \"WRO : xx is incomplete and cannot be associated. Please complete it first.\", \"WROID: xx with box number: n does not exist\", \"Cannot associate box n as it has already arrived at a Shipbob warehouse\", \"WRO ID: xx along with box number: n have already been associated to a URO\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.3.0.UnidentifiedReceivingOrder.AssociateWRO.Unprocessable.Entity.Object"}}}}},"requestBody":{"description":"The WRO and WRO box number to link the URO to","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.AssociateWroModel"}}}},"security":[{"PAT":[]}]}},"/2026-07/receiving/{id}/tracking":{"patch":{"operationId":"receiving_updateBoxTrackingForAWarehouseReceivingOrder","summary":"Update box tracking for a Warehouse Receiving Order\n","description":"Updates tracking numbers on the listed boxes and stamps the carrier onto them; boxes not listed are left unchanged. Tracking numbers must be unique across all boxes of the order. Not available when ShipBob shipping labels were purchased for the order — the purchased labels determine the tracking numbers.\n","tags":["receiving"],"parameters":[{"name":"id","in":"path","description":"Id of the receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Patch.3.0.Receiving.Id.Tracking.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.WarehouseReceivingOrderTrackingV3ViewModel"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.ProblemDetails"}}}},"422":{"description":"Unprocessable Content. Validation errors are returned keyed by field; business-rule errors that are not tied to a specific field are returned under an empty key. Rejected here when the order has ShipBob-purchased or already-generated shipping labels (the labels determine tracking), when a box number is not on the order, or when tracking numbers are duplicated across the listed boxes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Patch.3.0.Receiving.Id.Tracking.Unprocessable.Entity.Object"}}}}},"requestBody":{"description":"The tracking update to apply","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.UpdateReceivingOrderTrackingV3Model"}}}},"security":[{"PAT":[]}]}},"/2026-07/return":{"post":{"operationId":"returns_createReturnOrder","summary":"Create Return Order\n","description":"Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.\n","tags":["returns"],"parameters":[{"name":"shipbob_channel_id","in":"header","description":"Channel Id for operation\n","required":true,"schema":{"$ref":"#/components/schemas/Returns.Post.Return.Shipbob.Channel.Id.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.PublicReturnV1Dto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ApiError"}}}}},"requestBody":{"description":"The return order creation request containing return details, items, and configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnRequest"}}}},"security":[{"PAT":[]}]},"get":{"operationId":"returns_getReturnOrders","summary":"Get Return Orders\n","description":"Retrieves a paginated list of return orders with optional filters for IDs, statuses, dates, and other criteria. Use this to track all returns across your ShipBob account.\n","tags":["returns"],"parameters":[{"name":"Ids","in":"query","description":"The IDs of the returns to fetch. Accepts a comma-separated list of return IDs (e.g., 123,456,789).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Ids.String"}},{"name":"ReferenceIds","in":"query","description":"Comma-separated list of return reference IDs (RMA numbers) to filter by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.ReferenceIds.String"}},{"name":"Status","in":"query","description":"Comma-separated list of return statuses to filter by (e.g., AwaitingArrival, Arrived, Processing, Completed, Cancelled).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Status.String"}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma-separated list of fulfillment center IDs to filter by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.FulfillmentCenterIds.String"}},{"name":"TrackingNumbers","in":"query","description":"Comma-separated list of tracking numbers to filter by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.TrackingNumbers.String"}},{"name":"OriginalShipmentIds","in":"query","description":"Comma-separated list of original shipment IDs to filter by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.OriginalShipmentIds.String"}},{"name":"InventoryIds","in":"query","description":"Comma-separated list of inventory IDs to filter by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.InventoryIds.String"}},{"name":"StartDate","in":"query","description":"Filter returns created on or after this date (ISO 8601 format).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.StartDate.String"}},{"name":"EndDate","in":"query","description":"Filter returns created on or before this date (ISO 8601 format).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.EndDate.String"}},{"name":"ReturnTypes","in":"query","description":"Comma-separated list of return types to filter by (e.g., Regular, ReturnToSender).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.ReturnTypes.String"}},{"name":"ReturnActions","in":"query","description":"Comma-separated list of return actions to filter by (e.g., Restock, Quarantine, Dispose).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.ReturnActions.String"}},{"name":"StoreOrderIds","in":"query","description":"Comma-separated list of store order IDs to filter by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.StoreOrderIds.String"}},{"name":"Sortby","in":"query","description":"Field to sort results by.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Sortby.String"}},{"name":"CompletedStartDate","in":"query","description":"Filter returns completed on or after this date (ISO 8601 format).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.CompletedStartDate.String"}},{"name":"CompletedEndDate","in":"query","description":"Filter returns completed on or before this date (ISO 8601 format).\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.CompletedEndDate.String"}},{"name":"Cursor","in":"query","description":"Page number to retrieve. Used for pagination through result sets.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Cursor.Integer"}},{"name":"Limit","in":"query","description":"Maximum number of records to return per page.\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Limit.Integer"}},{"name":"SortOrder","in":"query","description":"Sort order for results. Desc = newest to oldest, Asc = oldest to newest, Desc is default\n","required":false,"schema":{"$ref":"#/components/schemas/202607ReturnGetParametersSortOrder"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for operation\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.PublicReturnDtoPagedUrlResultDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"}}}}},"security":[{"PAT":[]}]}},"/2026-07/return/{id}":{"get":{"operationId":"returns_getReturnOrder","summary":"Get Return Order\n","description":"Retrieves the complete details of a specific return order by its unique ID. Use this to view return status, inventory items, transactions, and processing history.\n","tags":["returns"],"parameters":[{"name":"id","in":"path","description":"The Id of the Return\n","required":true,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Id.Id.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation\n","required":false,"schema":{"$ref":"#/components/schemas/Returns.Get.Return.Id.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.PublicReturnDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"}}}}},"security":[{"PAT":[]}]},"put":{"operationId":"returns_editReturnOrder","summary":"Edit Return Order\n","description":"Updates an existing return using the provided request body and returns the updated return payload.\n","tags":["returns"],"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Returns.Put.Api.Public.Id.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.PublicReturnV1Dto"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ApiError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnRequest"}}}},"security":[{"PAT":[]}]}},"/2026-07/return/{id}:cancel":{"post":{"operationId":"returns_cancelReturnOrder","summary":"Cancel Return order\n","description":"Cancels a return order for given return ID.\n","tags":["returns"],"parameters":[{"name":"id","in":"path","description":"Id of the return order\n","required":true,"schema":{"$ref":"#/components/schemas/Returns.Post.Api.Public.Cancel.Id.Id.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns_cancelReturnOrder_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/webhook":{"post":{"operationId":"webhooks_createSubscription","summary":"Create Subscription\n","description":"This endpoint creates a new webhook subscription.\n","tags":["webhooks"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.V2.Create.WebhookViewModelV2"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.UnprocessableEntityObjectResult"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.V2.CreateSubscriptionRequest"}}}},"security":[{"PAT":[]}]},"get":{"operationId":"webhooks_getSubscriptions","summary":"Get Subscriptions\n","description":"  This endpoint returns a list of webhook subscriptions.\n","tags":["webhooks"],"parameters":[{"name":"RecordsPerPage","in":"query","description":"Number of webhooks returned per page in a paginated response.\n","required":false,"schema":{"$ref":"#/components/schemas/Webhooks.Get.V2.Webhook.RecordsPerPage.Integer"}},{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to retrieve the next or previous page of results. Omit to start at the first page.\n","required":false,"schema":{"$ref":"#/components/schemas/Webhooks.Get.V2.Webhook.Cursor.String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.GetWebhookResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.BadRequestObjectResult"}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/webhook/{id}":{"delete":{"operationId":"webhooks_deleteSubscription","summary":"Delete Subscription\n","description":"  This endpoint deletes a webhook subscription.\n","tags":["webhooks"],"parameters":[{"name":"id","in":"path","description":"This is the id of the webhook subscription to delete\n","required":true,"schema":{"$ref":"#/components/schemas/Webhooks.Delete.V2.Webhook.Id.Id.String"}}],"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"No access right at this time","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"No access","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/location":{"get":{"operationId":"locations_getLocations","summary":"Get Locations","description":"Retrieves physical locations across ShipBob's fulfillment network. An active location (`is_active=true`) is operational for fulfillment processes, including receiving inventory and processing returns. Access to locations varies: some are available to all merchants by default, while others require special approval. Use the `AccessGranted` parameter to determine if a location is available to the authenticated user, and `ReceivingEnabled` to confirm if the location accepts inventory.","tags":["locations"],"parameters":[{"name":"IncludeInactive","in":"query","description":"Whether the inactive locations should be included or not\n","required":false,"schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.IncludeInactive.Boolean"}},{"name":"ReceivingEnabled","in":"query","description":"Return all the receiving enabled locations\n","required":false,"schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.ReceivingEnabled.Boolean"}},{"name":"AccessGranted","in":"query","description":"Return all the access granted locations\n","required":false,"schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.AccessGranted.Boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.OK.OneOfArray"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/transactions:query":{"post":{"operationId":"billing_searchTransactions","summary":"Search Transactions","description":"Search transactions with filters (date, invoice, fee type, etc.)","tags":["billing"],"parameters":[{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Post.Api.V3.Transactions.Query.Cursor.String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponseV3"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Used to filter transactions based on search criteria. Required if cursor is not provided. Ignored when cursor is present (i.e., for paginated requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionRequestFilterV3"}}}},"security":[{"PAT":[]}]}},"/2026-07/invoices":{"get":{"operationId":"billing_getInvoices","summary":"Get Invoices","description":"Gets a paginated list of invoices, optionally filtered by invoice types and date range","tags":["billing"],"parameters":[{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.Cursor.String"}},{"name":"FromDate","in":"query","description":"[Optional] Start date for filtering invoices by invoice date. Default is current - 1 month date.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.FromDate.String"}},{"name":"ToDate","in":"query","description":"[Optional] End date for filtering invoices by invoice date. Default is current date.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.ToDate.String"}},{"name":"InvoiceTypes","in":"query","description":"[Optional] Filter invoices by invoice type.","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.InvoiceTypes.StringArray"}},{"name":"PageSize","in":"query","description":"Number of invoices to return per page (default: 100). Must be between 1 and 1000.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.PageSize.Integer","default":100}},{"name":"SortOrder","in":"query","description":"Sort invoices by Invoice Date. Values - Ascending, Descending. Default: Descending.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.SortOrder","default":"Descending"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.InvoiceDtoCursorPagedResponseV3"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.ProblemDetails"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.ProblemDetails"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/invoices/{invoiceId}/transactions":{"get":{"operationId":"billing_getTransactionsByInvoiceId","summary":"Get Transactions by Invoice ID\n","description":"The unique identifier of the invoice whose transactions are to be retrieved","tags":["billing"],"parameters":[{"name":"invoiceId","in":"path","description":"The unique identifier of the invoice whose transactions are to be retrieved.\n","required":true,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.InvoiceId.Integer"}},{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.Cursor.String"}},{"name":"PageSize","in":"query","description":"Number of transactions to return per page (default is 100, to be entered when API is called for first time). Must be between 1 and 1000.\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.PageSize.Integer","default":100}},{"name":"SortOrder","in":"query","description":"Sort order of the results. Valid values: Ascending or Descending (default: Descending).\n","required":false,"schema":{"$ref":"#/components/schemas/Billing.SortOrder","default":"Descending"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponseV3"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.ProblemDetails"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/transaction-fees":{"get":{"operationId":"billing_getTransactionFees","summary":"Get Transaction Fees\n","description":"This endpoint returns a list of transaction fees\n","tags":["billing"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionFeeModelV3"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"security":[{"PAT":[]}]}},"/2026-07/shipments-tracking":{"get":{"operationId":"tracking_getTrackingByShipmentIds","summary":"Get Tracking by Shipment Ids\n","description":"Retrieves tracking information for one or more shipments by their ShipBob shipment Ids. Returns the current status, carrier details, estimated delivery time, and full tracking history for each shipment. Accepts between 1 and 25 shipment Ids per request.\n","tags":["tracking"],"parameters":[{"name":"ShipmentIds","in":"query","description":"A list of ShipBob shipment IDs to retrieve tracking information for","required":false,"schema":{"$ref":"#/components/schemas/Tracking.Get.Api.V1.Publictracking.Shipments.ShipmentIds.IntegerArray"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tracking.ShipmentTrackingResponseArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tracking.Get.Api.V1.Publictracking.Shipments.Bad.Request.String"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tracking.Get.Api.V1.Publictracking.Shipments.Internal.Server.Error.String"}}}}},"security":[{"PAT":[]}]}},"/2026-07/tracking":{"get":{"operationId":"tracking_getTrackingByTrackingIds","summary":"Get Tracking by Tracking Ids\n","description":"Retrieves tracking information for one or more shipments by their carrier tracking IDs. Returns the current status, carrier details, estimated delivery time, and full tracking history for each tracking ID. Intended for platform-level consumers that reference shipments by carrier tracking number rather than ShipBob shipment ID.\n","tags":["tracking"],"parameters":[{"name":"TrackingIds","in":"query","description":"A list of carrier tracking Ids to retrieve tracking information for","required":false,"schema":{"$ref":"#/components/schemas/Tracking.Get.Api.V1.Publictracking.Tracking.Ids.TrackingIds.StringArray"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tracking.PlatformShipmentTrackingResponseArray"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Bad.Request.String"}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Internal.Server.Error.String"}}}}},"security":[{"PAT":[]}]}}},"tags":[{"name":"channels"},{"name":"orders"},{"name":"products"},{"name":"inventory"},{"name":"receiving"},{"name":"returns"},{"name":"webhooks"},{"name":"locations"},{"name":"billing"},{"name":"tracking"}],"servers":[{"url":"https://api.shipbob.com","description":"https://api.shipbob.com"},{"url":"https://sandbox-api.shipbob.com","description":"https://sandbox-api.shipbob.com"}],"components":{"schemas":{"Channels.ChannelViewModel":{"type":"object","properties":{"application_name":{"type":["string","null"],"description":"Name of the application that owns the channel"},"id":{"type":"integer","description":"Unique id of the channel"},"name":{"type":["string","null"],"description":"Name of the channel"},"scopes":{"type":["array","null"],"items":{"type":"string"},"description":"Array of permissions granted for the channel"}},"title":"Channels.ChannelViewModel"},"Channels.ChannelsV2ViewModel":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Channels.ChannelViewModel"},"description":"List of channels"},"next":{"type":["string","null"],"description":"Next page url"},"prev":{"type":["string","null"],"description":"Previous page url"}},"description":"Get Channels response","title":"Channels.ChannelsV2ViewModel"},"Channels.ErrorResponse":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Channels.ErrorResponse"},"Orders.Post.Api.Order.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Post.Api.Order.Shipbob.Channel.Id.Integer"},"Orders.Financials":{"type":"object","properties":{"total_price":{"type":["number","null"],"format":"double","description":"Sum of all line item prices, discounts, and taxes in USD"}},"title":"Orders.Financials"},"Orders.RequiredLotModel":{"type":"object","properties":{"lot_date":{"type":["string","null"],"format":"date-time","description":"Manually specified lot date"},"lot_number":{"type":["string","null"],"description":"Manually specified lot number"}},"description":"Manually specify the lot number/date that should be used to fulfill this order.","title":"Orders.RequiredLotModel"},"Orders.AddProductToOrderByReferenceIdModel":{"type":"object","properties":{"external_line_id":{"type":["integer","null"],"description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc."},"quantity":{"type":"integer","minimum":1,"maximum":2147483647,"description":"The quantity of this product ordered"},"quantity_unit_of_measure_code":{"type":["string","null"],"description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"},"required_lot":{"$ref":"#/components/schemas/Orders.RequiredLotModel"},"gtin":{"type":["string","null"],"minLength":0,"maxLength":50,"description":"Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1"},"name":{"type":["string","null"],"description":"Name of the product. Required if there is not an existing ShipBob product with a matching reference_id value."},"reference_id":{"type":"string","minLength":1,"description":"The seller SKU of the product in the sales channel named in shipbob_channel_id. For a Shopify channel this is the platform identifier of the variant. When no product matches and name is supplied, a new product is created with this reference id."},"sku":{"type":["string","null"],"description":"Product SKU"},"unit_price":{"type":["number","null"],"format":"double","description":"Price for one item"},"upc":{"type":["string","null"],"minLength":0,"maxLength":50,"description":"Universal Product Code - Unique external identifier"}},"required":["quantity","reference_id"],"title":"Orders.AddProductToOrderByReferenceIdModel"},"Orders.AddProductToOrderByProductIdModel":{"type":"object","properties":{"external_line_id":{"type":["integer","null"],"description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc."},"quantity":{"type":"integer","minimum":1,"maximum":2147483647,"description":"The quantity of this product ordered"},"quantity_unit_of_measure_code":{"type":["string","null"],"description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"},"required_lot":{"$ref":"#/components/schemas/Orders.RequiredLotModel"},"id":{"type":"integer","description":"The product id used by the sales channel named in shipbob_channel_id. The Products API returns it as legacy_product_id in the variant's channel_metadata."}},"required":["quantity","id"],"title":"Orders.AddProductToOrderByProductIdModel"},"OrdersCreateOrderModelProductsItems":{"oneOf":[{"$ref":"#/components/schemas/Orders.AddProductToOrderByReferenceIdModel"},{"$ref":"#/components/schemas/Orders.AddProductToOrderByProductIdModel"}],"title":"OrdersCreateOrderModelProductsItems"},"Orders.AddressViewModel":{"type":"object","properties":{"address1":{"type":"string","minLength":1,"description":"First line of the address"},"address2":{"type":["string","null"],"description":"Second line of the address"},"city":{"type":"string","minLength":1,"description":"The city"},"company_name":{"type":["string","null"],"description":"Name of the company receiving the shipment"},"country":{"type":"string","minLength":1,"description":"The country (Must be ISO Alpha-2 for estimates)"},"state":{"type":["string","null"],"description":"The state or province"},"zip_code":{"type":["string","null"],"format":"postal-code","description":"The zip code or postal code"}},"required":["address1","city","country"],"title":"Orders.AddressViewModel"},"Orders.AddressType":{"type":"string","enum":["MarkFor","ShipFrom"],"title":"Orders.AddressType"},"Orders.RetailerProgramDataAddressViewModel":{"type":"object","properties":{"address1":{"type":"string","minLength":1,"description":"First line of the address"},"address2":{"type":["string","null"],"description":"Second line of the address"},"city":{"type":"string","minLength":1,"description":"The city"},"company_name":{"type":["string","null"],"description":"Name of the company receiving the shipment"},"country":{"type":"string","minLength":1,"description":"The country (Must be ISO Alpha-2 for estimates)"},"state":{"type":["string","null"],"description":"The state or province"},"zip_code":{"type":["string","null"],"format":"postal-code","description":"The zip code or postal code"},"type":{"$ref":"#/components/schemas/Orders.AddressType"}},"required":["address1","city","country","type"],"description":"Address to used when creating a B2B/DropShip order.","title":"Orders.RetailerProgramDataAddressViewModel"},"OrdersRecipientInfoViewModelAddress":{"oneOf":[{"$ref":"#/components/schemas/Orders.AddressViewModel"},{"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"}],"description":"Address of the recipient","title":"OrdersRecipientInfoViewModelAddress"},"Orders.RecipientInfoViewModel":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/OrdersRecipientInfoViewModelAddress","description":"Address of the recipient"},"email":{"type":["string","null"],"format":"email","description":"Email address of the recipient"},"name":{"type":"string","minLength":1,"maxLength":300,"description":"Name of the recipient"},"phone_number":{"type":["string","null"],"maxLength":50,"description":"Phone number of the recipient"}},"required":["address","name"],"description":"Information about the recipient of an order","title":"Orders.RecipientInfoViewModel"},"Orders.RetailerProgramDataViewModel":{"type":"object","properties":{"addresses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"},"description":"Ship From - Certain retailers want to display the ship from address as their return facility, not Shipbob’s warehouse address        /// \r\nMark For Address - Final destination address"},"customer_ticket_number":{"type":["string","null"],"description":"Customer Ticket Number"},"delivery_date":{"type":["string","null"],"format":"date-time","description":"Expected delivery date"},"department":{"type":["string","null"],"description":"Identifies a merchant's store department"},"do_not_ship_before_date":{"type":["string","null"],"format":"date-time","description":"The date the retailer does not want the order shipped by."},"mark_for_store":{"type":["string","null"],"description":"Store Number"},"purchase_order_number":{"type":"string","minLength":1,"description":"First initial documentation sent from buyer to seller with item(s) and quantities."},"retailer_program_type":{"type":"string","minLength":1,"description":"Program code that identifies the retailer and merchant combination. The code must already exist in the ShipBob retailer program configuration. Use SB-B2B for a standard ShipBob B2B order, because it is the one code the API accepts without the merchant being enrolled first. Retailer specific codes, for example TGTDS, need ShipBob support to enroll the merchant, otherwise the API returns \"Merchant is not enabled for the Retailer Program Type\". The code must also agree with the order type, otherwise the API reports a different Retailer Program Type than the one configured for the program code. A carrier_type of Parcel combined with a payment_term of Collect or ThirdParty can also be rejected for SB-B2B, depending on the merchant's retailer configuration."},"ship_by_date":{"type":["string","null"],"format":"date-time","description":"The date the retailer has requested the order to ship by."}},"required":["purchase_order_number","retailer_program_type"],"description":"Contains properties that needs to be used for fulfilling B2B/Dropship orders.","title":"Orders.RetailerProgramDataViewModel"},"Orders.SalesChannel":{"type":"string","enum":["amazon","bigcommerce","ebay","faire","macy","magento","shein","shopify","squarespace","targetplus","temu","tiktok","unleashed","walmart","woocommerce"],"title":"Orders.SalesChannel"},"Orders.CarrierShipType":{"type":"string","enum":["Parcel","Freight"],"title":"Orders.CarrierShipType"},"Orders.PaymentShipTerm":{"type":"string","enum":["Collect","ThirdParty","Prepaid","MerchantResponsible"],"title":"Orders.PaymentShipTerm"},"Orders.ShippingTermsViewModel":{"type":"object","properties":{"carrier_type":{"$ref":"#/components/schemas/Orders.CarrierShipType"},"payment_term":{"$ref":"#/components/schemas/Orders.PaymentShipTerm"}},"description":"Contains shipping properties that need to be used for fulfilling an order.","title":"Orders.ShippingTermsViewModel"},"Orders.TagViewModel":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50,"description":"The key of the tag"},"value":{"type":"string","minLength":1,"maxLength":500,"description":"The value of the tag"}},"required":["name","value"],"title":"Orders.TagViewModel"},"Orders.OrderType":{"type":"string","enum":["DTC","DropShip","B2B"],"description":"Order type. DTC is a direct to consumer order. DropShip and B2B are retailer program order types.","title":"Orders.OrderType"},"Orders.CreateOrderModel":{"type":"object","properties":{"financials":{"$ref":"#/components/schemas/Orders.Financials"},"gift_message":{"type":["string","null"],"maxLength":500,"description":"Gift message associated with the order"},"location_id":{"type":["integer","null"],"description":"Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order."},"order_number":{"type":["string","null"],"maxLength":400,"description":"User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used"},"origin_platform_program":{"type":["string","null"],"maxLength":100,"description":"Origin platform program for the order. Accepts a program name."},"products":{"type":"array","items":{"$ref":"#/components/schemas/OrdersCreateOrderModelProductsItems"},"description":"Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product."},"purchase_date":{"type":["string","null"],"format":"date-time","description":"Date this order was purchase by the end user"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"type":"string","minLength":1,"maxLength":300,"description":"Unique and immutable order identifier from your upstream system"},"requested_delivery_date":{"type":["string","null"],"format":"date-time","description":"The delivery date requested by the source platform for the order in UTC"},"retailer_program_data":{"$ref":"#/components/schemas/Orders.RetailerProgramDataViewModel","description":"Required when type is DropShip or B2B. Omitting this object entirely, or supplying a retailer_program_type that is unrecognized or not enrolled, returns a 422 validation error; including the object without its required purchase_order_number or retailer_program_type fields returns a 400 validation error instead. Not used for DTC orders, where the API ignores this object."},"sales_channel":{"$ref":"#/components/schemas/Orders.SalesChannel"},"shipping_method":{"type":"string","minLength":1,"description":"Client-defined shipping method matching what the user has listed as the shipping method on the Ship Option Mapping setup page in the ShipBob Merchant Portal. If they don’t match, we will create a new one and default it to Standard"},"shipping_terms":{"$ref":"#/components/schemas/Orders.ShippingTermsViewModel","description":"Required when type is DropShip or B2B. For those order types both carrier_type and payment_term must be present. A carrier_type of Freight with a payment_term of ThirdParty is rejected. For DTC orders the only accepted combination is a carrier_type of Parcel with a payment_term of Prepaid, or both values left empty."},"tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.TagViewModel"},"description":"Key value pair array to store extra information at the order level for API purposes. ShipBob won't display the info in the ShipBob Merchant Portal or react based on this data."},"type":{"$ref":"#/components/schemas/Orders.OrderType","description":"Order type. Accepted values are DTC, DropShip and B2B. DropShip and B2B orders must also include retailer_program_data and shipping_terms, or the create request fails validation with a 422 response. For DTC orders the API ignores retailer_program_data."}},"required":["products","recipient","reference_id","shipping_method","type"],"title":"Orders.CreateOrderModel"},"Orders.ChannelInfoViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the channel"},"name":{"type":["string","null"],"description":"Name of the channel"}},"description":"Created by channel metadata","title":"Orders.ChannelInfoViewModel"},"Orders.ProductInfoViewModel":{"type":"object","properties":{"external_line_id":{"type":["integer","null"],"description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc."},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1"},"id":{"type":["integer","null"],"description":"Unique id of the product"},"quantity":{"type":"integer","description":"The quantity of this product ordered"},"quantity_unit_of_measure_code":{"type":["string","null"],"description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"},"reference_id":{"type":["string","null"],"description":"Unique reference id of the product"},"sku":{"type":["string","null"],"description":"Stock keeping unit for the product"},"unit_price":{"type":["number","null"],"format":"double","description":"Price for one item"},"upc":{"type":["string","null"],"description":"Universal Product Code - Unique external identifier"}},"title":"Orders.ProductInfoViewModel"},"Orders.FulfillmentStatus":{"type":"string","enum":["AwaitingInventoryAllocation","AwaitingReset","Unavailable","PendingOnTime","FulfilledOnTime","PendingLate","FulfilledLate"],"title":"Orders.FulfillmentStatus"},"Orders.FulfillmentCenterViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the fulfillment center"},"name":{"type":["string","null"],"description":"Name of the fulfillment center"}},"description":"Information about a fulfillment center that a shipment can belong to","title":"Orders.FulfillmentCenterViewModel"},"Orders.MeasurementsViewModel":{"type":"object","properties":{"depth_in":{"type":"integer","description":"Total depth in inches"},"length_in":{"type":"integer","description":"Total length in inches"},"total_weight_oz":{"type":"integer","description":"Total weight in ounces"},"width_in":{"type":"integer","description":"Total width in inches"}},"description":"Measurements of a shipment","title":"Orders.MeasurementsViewModel"},"Orders.PackageMaterialType":{"type":"string","enum":["Unknown","Box","BubbleMailer","PolyMailer","FragileBox","PosterTube","Custom","Bookfold","OwnContainer","Undefined"],"title":"Orders.PackageMaterialType"},"Orders.InventoryViewModel":{"type":"object","properties":{"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiration date of the inventory"},"id":{"type":"integer","description":"Unique id of the inventory"},"is_dangerous_goods":{"type":"boolean","description":"Is inventory Dangerous Good"},"lot":{"type":["string","null"],"description":"Lot number of the inventory"},"name":{"type":["string","null"],"description":"Name of the inventory item"},"quantity":{"type":"integer","description":"Quantity of the inventory item to be included in the fulfillment"},"quantity_committed":{"type":"integer","description":"The quantity of the inventory item allocated from the assigned fulfillment center and committed to the order. If quantity committed is less than order quantity, then the inventory item is out of stock at the assigned fulfillment center."},"serial_numbers":{"type":["array","null"],"items":{"type":"string"},"description":"Serial number of the inventory"}},"description":"Information about inventory belonging to a store product","title":"Orders.InventoryViewModel"},"Orders.ShipmentProductViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the product"},"inventory_items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.InventoryViewModel"},"description":"Information about fulfillable inventory items belonging to this product"},"name":{"type":["string","null"],"description":"Name of the product"},"reference_id":{"type":["string","null"],"description":"Unique reference id of the product"},"sku":{"type":["string","null"],"description":"Stock keeping unit for the product"}},"description":"Information about a store product belonging to a shipment","title":"Orders.ShipmentProductViewModel"},"Orders.CartonDetailsViewModel":{"type":"object","properties":{"products":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"description":"List of what is packed in this carton"}},"title":"Orders.CartonDetailsViewModel"},"Orders.CartonMeasurementsViewModel":{"type":"object","properties":{"depth_in":{"type":"number","format":"double","description":"Total depth in inches"},"length_in":{"type":"number","format":"double","description":"Total length in inches"},"total_weight_oz":{"type":"number","format":"double","description":"Total weight in ounces"},"width_in":{"type":"number","format":"double","description":"Total width in inches"}},"description":"Measurements of a carton","title":"Orders.CartonMeasurementsViewModel"},"Orders.CartonViewModel":{"type":"object","properties":{"barcode":{"type":["string","null"],"description":"Barcode assigned to this carton"},"carton_details":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.CartonDetailsViewModel"},"description":"Details about the contents of this carton"},"id":{"type":"integer","description":"ID assigned to this carton"},"measurements":{"$ref":"#/components/schemas/Orders.CartonMeasurementsViewModel"},"type":{"type":["string","null"],"description":"Type of this carton container"}},"title":"Orders.CartonViewModel"},"Orders.ParentCartonViewModel":{"type":"object","properties":{"barcode":{"type":["string","null"],"description":"Barcode assigned to this carton"},"cartons":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.CartonViewModel"},"description":"Cartons packed inside this parent container"},"measurements":{"$ref":"#/components/schemas/Orders.CartonMeasurementsViewModel"},"type":{"type":["string","null"],"description":"Type of this carton container"}},"title":"Orders.ParentCartonViewModel"},"OrdersRecipientViewModelAddress":{"oneOf":[{"$ref":"#/components/schemas/Orders.AddressViewModel"},{"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"}],"description":"Address of the recipient","title":"OrdersRecipientViewModelAddress"},"Orders.RecipientViewModel":{"type":"object","properties":{"address":{"oneOf":[{"$ref":"#/components/schemas/OrdersRecipientViewModelAddress"},{"type":"null"}],"description":"Address of the recipient"},"email":{"type":["string","null"],"format":"email","description":"Email address of the recipient"},"full_name":{"type":["string","null"],"description":"FullName of the recipient"},"name":{"type":["string","null"],"description":"Name of the recipient"},"phone_number":{"type":["string","null"],"format":"tel","description":"Phone number of the recipient"}},"description":"Information about the recipient of a shipment","title":"Orders.RecipientViewModel"},"Orders.OrderStatusEnum":{"type":"string","enum":["None","Processing","Completed","Exception","OnHold","Cancelled","CleanSweeped","LabeledCreated","ImportReview"],"title":"Orders.OrderStatusEnum"},"Orders.StatusInformationViewModel":{"type":"object","properties":{"validation_messages":{"type":["array","null"],"items":{"type":"string"}}},"title":"Orders.StatusInformationViewModel"},"Orders.StatusDetailViewModel":{"type":"object","properties":{"description":{"type":["string","null"],"description":"Describes what the status detail means"},"exception_fulfillment_center_id":{"type":["integer","null"]},"extra_information":{"$ref":"#/components/schemas/Orders.StatusInformationViewModel"},"id":{"type":"integer","description":"The id of the status detail"},"inventory_id":{"type":["integer","null"],"description":"Inventory Id the detail applies to (if applicable)"},"name":{"type":["string","null"],"description":"Short name of the status detail"}},"title":"Orders.StatusDetailViewModel"},"Orders.TrackingViewModel":{"type":"object","properties":{"bol":{"type":["string","null"],"description":"Bill of lading (BOL) number. Document acknowledging receipt of cargo for shipment."},"carrier":{"type":["string","null"],"description":"Carrier of the shipment"},"carrier_service":{"type":["string","null"],"description":"The carrier's service which was used for this shipment"},"pro_number":{"type":["string","null"],"description":"Tracking number used for freight carriers"},"scac":{"type":["string","null"],"description":"Standard Carrier Alpha Code (SCAC). Unique 2-4 letter code used to identify transportation companies."},"shipping_date":{"type":["string","null"],"format":"date-time","description":"Date freight was shipped on"},"tracking_number":{"type":["string","null"],"description":"Tracking number of the shipment"},"tracking_url":{"type":["string","null"],"description":"URL to the website where a shipment can be tracked"}},"description":"Tracking information for a shipment","title":"Orders.TrackingViewModel"},"Orders.ShipmentViewModel":{"type":"object","properties":{"actual_fulfillment_date":{"type":["string","null"],"format":"date-time","description":"The datetime of ShipBob’s completion of the fulfillment operation as promised.\r\nCurrently, this means the shipment has been picked, packed, and label has been printed."},"created_date":{"type":"string","format":"date-time","description":"Date this shipment was created"},"delivery_date":{"type":["string","null"],"format":"date-time","description":"The datetime of Shipment delivered to customer."},"estimated_fulfillment_date":{"type":["string","null"],"format":"date-time","description":"The datetime of ShipBob’s commitment for completing\r\nthe shipment and handing to the carrier for delivery."},"estimated_fulfillment_date_status":{"$ref":"#/components/schemas/Orders.FulfillmentStatus"},"gift_message":{"type":["string","null"],"maxLength":500,"description":"Gift message associated with the shipment"},"id":{"type":"integer","description":"Unique id of the shipment"},"insurance_value":{"type":["number","null"],"format":"double","description":"Monetary amount that this shipment was insured for"},"invoice_amount":{"type":["number","null"],"format":"double","description":"Monetary amount that was invoiced for this shipment"},"invoice_currency_code":{"type":["string","null"]},"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated."},"last_tracking_update_at":{"type":["string","null"],"format":"date-time","description":"Timestamp for the last time this shipment had a tracking update"},"last_update_at":{"type":["string","null"],"format":"date-time","description":"Date this shipment was last updated"},"location":{"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"measurements":{"$ref":"#/components/schemas/Orders.MeasurementsViewModel"},"order_id":{"type":"integer","description":"Id of the order this shipment belongs to"},"package_material_type":{"$ref":"#/components/schemas/Orders.PackageMaterialType"},"parent_cartons":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ParentCartonViewModel"},"description":"Carton information for this shipment"},"products":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"description":"Information about the products contained in this shipment"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientViewModel"},"reference_id":{"type":["string","null"],"description":"Client-defined external unique id of the order this shipment belongs to"},"require_signature":{"type":"boolean","description":"If a shipment requires signature"},"ship_option":{"type":["string","null"],"description":"Name of the shipping option used for this shipment"},"status":{"$ref":"#/components/schemas/Orders.OrderStatusEnum"},"status_details":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.StatusDetailViewModel"},"description":"Additional details about the shipment status"},"tracking":{"$ref":"#/components/schemas/Orders.TrackingViewModel"}},"description":"Information about a shipment","title":"Orders.ShipmentViewModel"},"Orders.OrderStatus":{"type":"string","enum":["Processing","Exception","PartiallyFulfilled","Fulfilled","Cancelled","ImportReview"],"title":"Orders.OrderStatus"},"Orders.OrderViewModel":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Orders.ChannelInfoViewModel"},"created_date":{"type":"string","format":"date-time","description":"Date this order was created"},"financials":{"$ref":"#/components/schemas/Orders.Financials"},"gift_message":{"type":["string","null"],"description":"Gift message associated with the order"},"id":{"type":"integer","description":"Unique id of the order"},"order_number":{"type":["string","null"],"description":"User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used"},"products":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ProductInfoViewModel"},"description":"List of products included in the order"},"purchase_date":{"type":["string","null"],"format":"date-time","description":"Date this order was purchase by the end user"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"type":["string","null"],"description":"Client-defined external unique id of the order"},"retailer_program_data":{"$ref":"#/components/schemas/Orders.RetailerProgramDataViewModel"},"shipments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ShipmentViewModel"},"description":"Shipments affiliated with the order"},"shipping_method":{"type":["string","null"],"description":"Client-defined shipping method"},"shipping_terms":{"$ref":"#/components/schemas/Orders.ShippingTermsViewModel"},"status":{"$ref":"#/components/schemas/Orders.OrderStatus"},"tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.TagViewModel"},"description":"Client-defined order tags"},"type":{"$ref":"#/components/schemas/Orders.OrderType"}},"title":"Orders.OrderViewModel"},"Orders.Post.Api.Order.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.Bad.Request.Object"},"Orders.Post.Api.Order.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.Unprocessable.Entity.Object"},"Orders.Get.Api.Order.Page.Integer":{"type":"integer","minimum":1,"maximum":2147483647,"title":"Orders.Get.Api.Order.Page.Integer"},"Orders.Get.Api.Order.Limit.Integer":{"type":"integer","minimum":1,"maximum":250,"title":"Orders.Get.Api.Order.Limit.Integer"},"Orders.Get.Api.Order.IDs.IntegerArray":{"type":"array","items":{"type":"integer"},"title":"Orders.Get.Api.Order.IDs.IntegerArray"},"Orders.Get.Api.Order.ReferenceIds.StringArray":{"type":"array","items":{"type":"string"},"title":"Orders.Get.Api.Order.ReferenceIds.StringArray"},"Orders.Get.Api.Order.StartDate.String":{"type":"string","format":"date-time","title":"Orders.Get.Api.Order.StartDate.String"},"Orders.Get.Api.Order.EndDate.String":{"type":"string","format":"date-time","title":"Orders.Get.Api.Order.EndDate.String"},"Orders.SortOrder":{"type":"string","enum":["Newest","Oldest"],"title":"Orders.SortOrder"},"Orders.Get.Api.Order.HasTracking.Boolean":{"type":"boolean","title":"Orders.Get.Api.Order.HasTracking.Boolean"},"Orders.Get.Api.Order.LastUpdateStartDate.String":{"type":"string","format":"date-time","title":"Orders.Get.Api.Order.LastUpdateStartDate.String"},"Orders.Get.Api.Order.LastUpdateEndDate.String":{"type":"string","format":"date-time","title":"Orders.Get.Api.Order.LastUpdateEndDate.String"},"Orders.Get.Api.Order.IsTrackingUploaded.Boolean":{"type":"boolean","title":"Orders.Get.Api.Order.IsTrackingUploaded.Boolean"},"Orders.Get.Api.Order.LastTrackingUpdateStartDate.String":{"type":"string","format":"date-time","title":"Orders.Get.Api.Order.LastTrackingUpdateStartDate.String"},"Orders.Get.Api.Order.LastTrackingUpdateEndDate.String":{"type":"string","format":"date-time","title":"Orders.Get.Api.Order.LastTrackingUpdateEndDate.String"},"Orders.Get.Api.Order.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Order.Shipbob.Channel.Id.Integer"},"Orders.OrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.OrderViewModel"},"title":"Orders.OrderViewModelArray"},"Orders.Get.Api.Order.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.Bad.Request.Object"},"Orders.Get.Api.Order.OrderId.OrderId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.OrderId.Integer"},"Orders.Get.Api.Order.OrderId.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipbob.Channel.Id.Integer"},"Orders.Get.Api.Order.OrderId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.Bad.Request.Object"},"Orders.Get.Api.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.Shipment.ShipmentId.ShipmentId.Integer"},"Orders.Get.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"},"Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object"},"Orders.Get.Api.Shipment.ShipmentId.Timeline.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.Shipment.ShipmentId.Timeline.ShipmentId.Integer"},"Orders.Get.Api.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer"},"Orders.ShipmentLogViewModel":{"type":"object","properties":{"log_type_id":{"type":"integer","description":"Log type id of the shipment"},"log_type_name":{"type":["string","null"],"description":"Name of the log type"},"log_type_text":{"type":["string","null"],"description":"Summary of log type meaning"},"metadata":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"Specifics data for the event"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp of event"}},"title":"Orders.ShipmentLogViewModel"},"Orders.ShipmentLogViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModel"},"title":"Orders.ShipmentLogViewModelArray"},"Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object"},"Orders.Post.Api.Shipment.Cancelbulk.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Post.Api.Shipment.Cancelbulk.Shipbob.Channel.Id.Integer"},"Orders.CancelShipmentsModel":{"type":"object","properties":{"shipment_ids":{"type":["array","null"],"items":{"type":"integer"},"description":"Shipment IDs to cancel"}},"description":"Model for cancel multiple shipments at once","title":"Orders.CancelShipmentsModel"},"Orders.ShipmentAction":{"type":"string","enum":["CleanSweep","Reassign","ReleaseOrderHold","MoveToOnHoldAndKeepInventory","MoveToOnHoldAndReleaseInventory","Cancel","AddLineItem","RemoveLineItem","UpdateShipOption"],"title":"Orders.ShipmentAction"},"Orders.CanceledShipmentViewModel":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/Orders.ShipmentAction"},"is_success":{"type":"boolean","description":"If the cancel action was successful"},"reason":{"type":["string","null"],"description":"The reason the cancellation result"},"shipment_id":{"type":"integer","format":"int64","description":"The ID of the shipment"}},"title":"Orders.CanceledShipmentViewModel"},"Orders.CanceledShipmentsViewModel":{"type":"object","properties":{"results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.CanceledShipmentViewModel"},"description":"The results of all cancellation actions"}},"title":"Orders.CanceledShipmentsViewModel"},"Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object"},"Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object"},"Orders.BulkUpdateTrackingUploadModel":{"type":"object","properties":{"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated.\r\nApplies to all shipments in shipment_ids"},"shipment_ids":{"type":["array","null"],"items":{"type":"integer"},"description":"Shipment IDs to apply the tracking upload status to"}},"description":"Model for updating tracking upload status for multiple shipments","title":"Orders.BulkUpdateTrackingUploadModel"},"Orders.BulkUpdateResponseError":{"type":"object","properties":{"code":{"type":["string","null"]},"message":{"type":["string","null"]}},"title":"Orders.BulkUpdateResponseError"},"Orders.BulkUpdateResponseResult":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseError"},"isSuccess":{"type":"boolean"},"shipmentId":{"type":"integer","format":"int64"}},"title":"Orders.BulkUpdateResponseResult"},"Orders.BulkUpdateResponseSummary":{"type":"object","properties":{"failed":{"type":"integer"},"successful":{"type":"integer"},"total":{"type":"integer"}},"title":"Orders.BulkUpdateResponseSummary"},"Orders.BulkUpdateResponseModel":{"type":"object","properties":{"results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseResult"}},"summary":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseSummary"}},"title":"Orders.BulkUpdateResponseModel"},"Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String":{"type":"string","title":"Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String"},"Orders.Post.Api.Order.Estimate.Delivery.Date.X.Correlation.Id.String":{"type":"string","format":"uuid","title":"Orders.Post.Api.Order.Estimate.Delivery.Date.X.Correlation.Id.String"},"OrdersPostApiOrderEstimateDeliveryDateRequestObjectDestinationAddress":{"type":"object","properties":{"address1":{"type":["string","null"],"description":"Street address line 1. Required for Checkout flow; omit for PDP flow."},"address2":{"type":["string","null"],"description":"Optional street address line 2 (suite, unit, etc.)."},"city":{"type":["string","null"],"description":"City. Required for Checkout flow; omit for PDP flow."},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. \"US\"). Required for both PDP and Checkout flows."},"state":{"type":["string","null"],"description":"State or province code (e.g. \"IL\"). Required for Checkout flow; omit for PDP flow."},"zip_code":{"type":"string","description":"Postal/ZIP code. Required for both PDP and Checkout flows."}},"required":["country","zip_code"],"description":"Destination address for a POST /order:estimateDeliveryDate request.","title":"OrdersPostApiOrderEstimateDeliveryDateRequestObjectDestinationAddress"},"OrdersPostApiOrderEstimateDeliveryDateRequestObjectLineItemsItems":{"type":"object","properties":{"inventory_id":{"type":["integer","null"],"description":"ShipBob inventory ID. Provide this or `sku`, not both."},"quantity":{"type":["integer","null"],"description":"Optional. Quantity of this item. Must be greater than zero when specified."},"sku":{"type":["string","null"],"description":"Merchant SKU. Provide this or `inventory_id`, not both."}},"description":"A single line item in a POST /order:estimateDeliveryDate request. Either `inventory_id` or `sku` must be provided; not both, not neither.","title":"OrdersPostApiOrderEstimateDeliveryDateRequestObjectLineItemsItems"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Request.Object":{"type":"object","properties":{"destination_address":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateRequestObjectDestinationAddress","description":"Destination address for a POST /order:estimateDeliveryDate request."},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateRequestObjectLineItemsItems"},"description":"The items to estimate. For PDP flow, exactly one item is required. For Checkout flow, one or more items are required. Each item must supply either `inventory_id` or `sku`."},"reference_id":{"type":["string","null"],"description":"Optional. Caller-supplied correlation identifier echoed back in the response."}},"required":["destination_address","line_items"],"description":"Request body for POST /order:estimateDeliveryDate. `destination_address.zip_code` and `destination_address.country` are required for every request — missing, empty, or whitespace values are rejected with HTTP 400 MISSING_REQUIRED_FIELDS naming all missing fields. The flow is auto-detected from the request shape: - **PDP flow**: `destination_address` contains only `zip_code` and `country`, and `line_items` contains exactly one item. Returns delivery-date estimates across Promise shipping services (no pricing fields). If no fulfillment center is available, returns HTTP 200 with an empty `estimates` array. - **Checkout flow**: `destination_address` contains a full address (`address1`, `city`, `state`, `zip_code`, `country`) with one or more line items. Returns delivery-date estimates plus full shipping cost and measurement fields. If no fulfillment center is available, returns HTTP 200 with NO_FULFILLMENT_CENTER_AVAILABLE in `errors`. - **Neither**: returns HTTP 400 AMBIGUOUS_FLOW.","title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Request.Object"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectErrorsItemsCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectErrorsItemsCode"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectErrorsItems":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectErrorsItemsCode","description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Optional structured context (key/value pairs) with additional detail about the error."},"correlation_id":{"type":["string","null"],"description":"Correlation identifier for this error, for tracing the failure across logs. May be null."},"description":{"type":["string","null"],"description":"Human-readable explanation of the error. May be null when the code is self-explanatory."}},"description":"Error entry in an API response. Lives inside the response `errors` array on successful (200) responses that carry per-FC failures or a system-can't-fulfill outcome. Reusable across any FulfillmentEstimator response DTO (not EDD-specific).","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectErrorsItems"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsLocation":{"type":"object","properties":{"id":{"type":"integer","description":"ShipBob fulfillment center (location) identifier."},"name":{"type":["string","null"],"description":"Display name of the fulfillment center."}},"description":"Fulfillment center (location) reference in an EDD response estimate.","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsLocation"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsMeasurements":{"type":"object","properties":{"depth_in":{"type":["number","null"],"format":"double","description":"Estimated package depth (height) in inches."},"length_in":{"type":["number","null"],"format":"double","description":"Estimated package length in inches."},"total_weight_oz":{"type":["number","null"],"format":"double","description":"Estimated total package weight in ounces."},"width_in":{"type":["number","null"],"format":"double","description":"Estimated package width in inches."}},"description":"Package measurements for a POST /order:estimateDeliveryDate Checkout estimate. Null on the parent estimate for PDP responses.","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsMeasurements"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsShippingCost":{"type":"object","properties":{"currency_code":{"type":["string","null"],"description":"ISO 4217 three-letter currency code (e.g. \"USD\"). Defaults to \"USD\"."},"value":{"type":"number","format":"double","description":"The monetary amount."}},"description":"A monetary value with its ISO 4217 currency code.","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsShippingCost"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsShippingService":{"type":"object","properties":{"id":{"type":"integer","description":"ShipBob shipping service (ship option) identifier."},"is_promise":{"type":"boolean","description":"True when this service is a Promise (delivery-date-backed) shipping service."},"name":{"type":["string","null"],"description":"Display name of the shipping service (e.g. \"Standard\", \"2-Day\")."},"shipping_methods":{"type":"array","items":{"type":"string"},"description":"Merchant-published ShippingMethod values from ShipOptionUserMapping for this (merchant, ShipOptionId), ordered by MappingId DESC (newest first) and capped at ApplicationSettings.ShippingMethodsLimit (default 20). Empty array when the merchant has no active mapping row for this service (e.g. default services added unconditionally in Precise; promise services exposed in Approximate without a per-merchant mapping)."}},"description":"Shipping service reference in an EDD response estimate.","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsShippingService"},"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItems":{"type":"object","properties":{"delivery_date":{"type":["string","null"],"format":"date-time","description":"Estimated delivery date in UTC. Null if the EDD service was unavailable or could not determine a date for this shipping service and fulfillment center. A null value does not block the response — other estimates may still have dates."},"location":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsLocation","description":"Fulfillment center (location) reference in an EDD response estimate."},"measurements":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsMeasurements","description":"Package measurements for a POST /order:estimateDeliveryDate Checkout estimate. Null on the parent estimate for PDP responses."},"order_by_date":{"type":["string","null"],"format":"date-time","description":"Latest UTC time the order must be placed to meet `delivery_date`. Derived from the fulfillment center's daily cutoff time and timezone. Null when `delivery_date` is null."},"packing_material":{"type":["string","null"],"description":"Checkout only. Packing material used for the shipment (e.g. \"Box\", \"Poly Mailer\")."},"shipping_cost":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsShippingCost","description":"A monetary value with its ISO 4217 currency code."},"shipping_service":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItemsShippingService","description":"Shipping service reference in an EDD response estimate."}},"description":"A single estimate entry in the POST /order:estimateDeliveryDate response. Checkout-only fields (`shipping_cost`, `measurements`, `packing_material`) are null for PDP responses.","title":"OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItems"},"Orders.Post.Api.Order.Estimate.Delivery.Date.OK.Object":{"type":"object","properties":{"destination_time_zone":{"type":["string","null"],"description":"IANA time-zone id of the destination (e.g. America/New_York), best-effort. Serialized as destination_time_zone. Null when it can't be resolved (non-US destination, unknown zip, or lookup failure) — callers must treat it as optional."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectErrorsItems"},"description":"Errors encountered while computing partial results. Empty on a fully successful response."},"estimates":{"type":"array","items":{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateOkObjectEstimatesItems"},"description":"The list of estimates, one per eligible shipping service and fulfillment center combination. Empty when no fulfillment center is available for a PDP request."},"reference_id":{"type":["string","null"],"description":"Echoed from the request's ReferenceId for caller correlation. Null if not supplied."}},"description":"Response body for POST /order:estimateDeliveryDate.","title":"Orders.Post.Api.Order.Estimate.Delivery.Date.OK.Object"},"OrdersPostApiOrderEstimateDeliveryDateBadRequestObjectCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateBadRequestObjectCode"},"OrdersPostApiOrderEstimateDeliveryDateBadRequestObjectContext":{"type":"object","properties":{},"title":"OrdersPostApiOrderEstimateDeliveryDateBadRequestObjectContext"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Bad.Request.Object":{"type":"object","properties":{"code":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateBadRequestObjectCode"},{"type":"null"}],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateBadRequestObjectContext"},{"type":"null"}]},"correlation_id":{"type":["string","null"],"format":"uuid"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":"integer"},"title":{"type":"string"},"trace_id":{"type":["string","null"]},"type":{"type":"string","format":"uri"}},"title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Bad.Request.Object"},"OrdersPostApiOrderEstimateDeliveryDateNotFoundObjectCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateNotFoundObjectCode"},"OrdersPostApiOrderEstimateDeliveryDateNotFoundObjectContext":{"type":"object","properties":{},"title":"OrdersPostApiOrderEstimateDeliveryDateNotFoundObjectContext"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Not.Found.Object":{"type":"object","properties":{"code":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateNotFoundObjectCode"},{"type":"null"}],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateNotFoundObjectContext"},{"type":"null"}]},"correlation_id":{"type":["string","null"],"format":"uuid"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":"integer"},"title":{"type":"string"},"trace_id":{"type":["string","null"]},"type":{"type":"string","format":"uri"}},"title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Not.Found.Object"},"OrdersPostApiOrderEstimateDeliveryDateUnprocessableEntityObjectCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateUnprocessableEntityObjectCode"},"OrdersPostApiOrderEstimateDeliveryDateUnprocessableEntityObjectContext":{"type":"object","properties":{},"title":"OrdersPostApiOrderEstimateDeliveryDateUnprocessableEntityObjectContext"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Unprocessable.Entity.Object":{"type":"object","properties":{"code":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateUnprocessableEntityObjectCode"},{"type":"null"}],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateUnprocessableEntityObjectContext"},{"type":"null"}]},"correlation_id":{"type":["string","null"],"format":"uuid"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":"integer"},"title":{"type":"string"},"trace_id":{"type":["string","null"]},"type":{"type":"string","format":"uri"}},"title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Unprocessable.Entity.Object"},"OrdersPostApiOrderEstimateDeliveryDateInternalServerErrorObjectCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateInternalServerErrorObjectCode"},"OrdersPostApiOrderEstimateDeliveryDateInternalServerErrorObjectContext":{"type":"object","properties":{},"title":"OrdersPostApiOrderEstimateDeliveryDateInternalServerErrorObjectContext"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Internal.Server.Error.Object":{"type":"object","properties":{"code":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateInternalServerErrorObjectCode"},{"type":"null"}],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateInternalServerErrorObjectContext"},{"type":"null"}]},"correlation_id":{"type":["string","null"],"format":"uuid"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":"integer"},"title":{"type":"string"},"trace_id":{"type":["string","null"]},"type":{"type":"string","format":"uri"}},"title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Internal.Server.Error.Object"},"OrdersPostApiOrderEstimateDeliveryDateBadGatewayObjectCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateBadGatewayObjectCode"},"OrdersPostApiOrderEstimateDeliveryDateBadGatewayObjectContext":{"type":"object","properties":{},"title":"OrdersPostApiOrderEstimateDeliveryDateBadGatewayObjectContext"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Bad.Gateway.Object":{"type":"object","properties":{"code":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateBadGatewayObjectCode"},{"type":"null"}],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateBadGatewayObjectContext"},{"type":"null"}]},"correlation_id":{"type":["string","null"],"format":"uuid"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":"integer"},"title":{"type":"string"},"trace_id":{"type":["string","null"]},"type":{"type":"string","format":"uri"}},"title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Bad.Gateway.Object"},"OrdersPostApiOrderEstimateDeliveryDateGatewayTimeoutObjectCode":{"type":"string","enum":["AMBIGUOUS_FLOW","MISSING_REQUIRED_FIELDS","INVALID_LINE_ITEM","INVALID_QUANTITY","INVALID_MERCHANT_ID","NO_FULFILLMENT_CENTER_AVAILABLE","INVENTORY_NOT_FOUND","INVENTORY_NOT_MEASURED","WEIGHT_LIMIT_EXCEEDED","PACKAGE_SELECTION_FAILED","NO_SHIPPING_SERVICES_AVAILABLE","EDD_LOOKUP_FAILED","DEPENDENCY_TIMEOUT","DEPENDENCY_UNAVAILABLE"],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means.","title":"OrdersPostApiOrderEstimateDeliveryDateGatewayTimeoutObjectCode"},"OrdersPostApiOrderEstimateDeliveryDateGatewayTimeoutObjectContext":{"type":"object","properties":{},"title":"OrdersPostApiOrderEstimateDeliveryDateGatewayTimeoutObjectContext"},"Orders.Post.Api.Order.Estimate.Delivery.Date.Gateway.Timeout.Object":{"type":"object","properties":{"code":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateGatewayTimeoutObjectCode"},{"type":"null"}],"description":"Machine-readable error code surfaced by FulfillmentEstimator endpoints. See the description next to each value below for what it means."},"context":{"oneOf":[{"$ref":"#/components/schemas/OrdersPostApiOrderEstimateDeliveryDateGatewayTimeoutObjectContext"},{"type":"null"}]},"correlation_id":{"type":["string","null"],"format":"uuid"},"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":"integer"},"title":{"type":"string"},"trace_id":{"type":["string","null"]},"type":{"type":"string","format":"uri"}},"title":"Orders.Post.Api.Order.Estimate.Delivery.Date.Gateway.Timeout.Object"},"Orders.Post.Api.Order.Estimate.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Post.Api.Order.Estimate.Shipbob.Channel.Id.Integer"},"Orders.EstimationAddressViewModel":{"type":"object","properties":{"address1":{"type":["string","null"],"description":"First line of the address"},"address2":{"type":["string","null"],"description":"Second line of the address"},"city":{"type":["string","null"],"description":"The city"},"company_name":{"type":["string","null"],"description":"Name of the company receiving the shipment"},"country":{"type":"string","minLength":1,"description":"The country (Must be ISO Alpha-2 for estimates)"},"state":{"type":["string","null"],"description":"The state or province"},"zip_code":{"type":["string","null"],"format":"postal-code","description":"The zip code or postal code"}},"required":["country"],"title":"Orders.EstimationAddressViewModel"},"Orders.EstimateProductInfoModel":{"type":"object","properties":{"id":{"type":["integer","null"],"description":"The legacy product id of the product in this channel, as returned by GET /product in channel_metadata[].legacy_product_id. Not the inventory id and not the variant id. Provide this or reference_id."},"quantity":{"type":"integer","minimum":1,"maximum":199,"description":"The quantity of this product ordered"},"reference_id":{"type":["string","null"],"description":"The reference id of the product in this channel, as shown in channel_metadata on GET /product: the seller SKU for most channels, or the platform identifier for Shopify channels. Provide this or id."}},"required":["quantity"],"title":"Orders.EstimateProductInfoModel"},"Orders.EstimateFulfillmentRequestModel":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Orders.EstimationAddressViewModel"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Orders.EstimateProductInfoModel"},"description":"Products to be included in the order. Each product must include one of reference_id or id"},"shipping_methods":{"type":["array","null"],"items":{"type":"string"},"description":"Array of strings specifying shipping methods for which to fetch estimates.\r\n\r\nIf this field is omitted we will return estimates for all shipping methods defined in ShipBob"}},"required":["address","products"],"title":"Orders.EstimateFulfillmentRequestModel"},"Orders.EstimateDetailViewModel":{"type":"object","properties":{"estimated_currency_code":{"type":["string","null"],"description":"Estimated local currency code"},"estimated_price":{"type":"number","format":"double","description":"Estimated price in dollars for the provided shipping method"},"fulfillment_center":{"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"shipping_method":{"type":["string","null"],"description":"Provided shipping method. Maps to ship option in ShipBob."},"total_weight_oz":{"type":"number","format":"double","description":"Total weight of items in cart including packaging."}},"title":"Orders.EstimateDetailViewModel"},"Orders.EstimateViewModel":{"type":"object","properties":{"estimates":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.EstimateDetailViewModel"},"description":"Array of estimates for each shipping method"}},"title":"Orders.EstimateViewModel"},"Orders.Post.Api.Order.Estimate.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.Estimate.Bad.Request.Object"},"Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object"},"Orders.Put.Api.V.Version.Shipment.ShipmentId.UpdateAddress.ShipmentId.Integer":{"type":"integer","title":"Orders.Put.Api.V.Version.Shipment.ShipmentId.UpdateAddress.ShipmentId.Integer"},"Orders.UpdateAddressRequest":{"type":"object","properties":{"city":{"type":"string","minLength":1,"description":"City of customer address"},"company_name":{"type":["string","null"],"description":"Company name (optional)"},"country_code":{"type":["string","null"],"description":"Country code of customer address"},"email":{"type":["string","null"],"description":"Customer's email address"},"override_verification":{"type":"boolean","default":false,"description":"When true, the address is saved even if it fails address validation (validation is bypassed). Defaults to false."},"phone_number":{"type":["string","null"],"description":"Phone number of Recipient address"},"recipient_name":{"type":["string","null"],"description":"Name of customer"},"state":{"type":["string","null"],"description":"State of customer address"},"street_address1":{"type":"string","minLength":1,"description":"Street Address 1"},"street_address2":{"type":["string","null"],"description":"Street Address 2"},"zip_code":{"type":["string","null"],"description":"Zipcode of customer address"}},"required":["city","street_address1"],"title":"Orders.UpdateAddressRequest"},"Orders.ErrorCode":{"type":"string","enum":["INVALID_PARAMETER","VALIDATION_ERROR","DATABASE_UPDATE_ERROR","REPROCESSING_ERROR","DEALLOCATE_ERROR","NOT_FOUND","CONFLICT","FORBIDDEN","UPSTREAM_ERROR","SHIPMENT_NOT_FOUND","ORDER_TYPE_NOT_SUPPORTED","SHIPMENT_ALREADY_PACKED","SHIPMENT_CANCELLED","SHIPMENT_SHIPPED"],"title":"Orders.ErrorCode"},"Orders.ErrorResponse":{"type":"object","properties":{"code":{"$ref":"#/components/schemas/Orders.ErrorCode","description":"Error code identifying the type of error"},"message":{"type":["string","null"],"description":"Human-readable description of the error"}},"title":"Orders.ErrorResponse"},"Orders.ShipmentApiResponse":{"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/Orders.ErrorResponse"},{"type":"null"}],"description":"Error details if the update was not successful"},"id":{"type":"integer","format":"int64","description":"Unique identifier of the shipment"},"is_success":{"type":"boolean","description":"Indicates whether the update was successful"}},"title":"Orders.ShipmentApiResponse"},"Orders.Get.Api.V.Version.Shipment.ShipmentId.GetLineItems.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.V.Version.Shipment.ShipmentId.GetLineItems.ShipmentId.Integer"},"Orders.LotSelectionMethod":{"type":"string","enum":["ShipbobChooses","Specific"],"title":"Orders.LotSelectionMethod"},"Orders.LotInfo":{"type":"object","properties":{"lot_date":{"type":["string","null"],"format":"date-time","description":"Expiration or manufacturing date of the lot"},"lot_number":{"type":["string","null"],"description":"Lot number identifying a specific batch of inventory"},"selection_method":{"$ref":"#/components/schemas/Orders.LotSelectionMethod","description":"Method used to select the lot for fulfillment"}},"title":"Orders.LotInfo"},"Orders.ProductVariantDetail":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product variant"},"name":{"type":["string","null"],"description":"Display name of the product variant"},"sku":{"type":["string","null"],"description":"Stock keeping unit identifier for the product variant"}},"title":"Orders.ProductVariantDetail"},"Orders.ShipmentLineItemDetail":{"type":"object","properties":{"committed_quantity":{"type":"integer","description":"Quantity of the inventory item committed for fulfillment"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"is_hazmat":{"type":["boolean","null"],"description":"Indicates whether the inventory item is classified as hazardous material"},"is_lot":{"type":["boolean","null"],"description":"Indicates whether the inventory item is lot-tracked"},"lot":{"$ref":"#/components/schemas/Orders.LotInfo","description":"Lot information for the inventory item, if lot-tracked"},"product_variant":{"$ref":"#/components/schemas/Orders.ProductVariantDetail","description":"Product variant details associated with this line item"},"quantity":{"type":"integer","description":"Total quantity of the inventory item in the shipment"},"serial_numbers":{"type":["array","null"],"items":{"type":"string"},"description":"List of serial numbers assigned to this line item"}},"title":"Orders.ShipmentLineItemDetail"},"Orders.ShipmentLineItemDetailArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentLineItemDetail"},"title":"Orders.ShipmentLineItemDetailArray"},"Orders.Post.Api.V.Version.Shipment.ShipmentId.UpdateLineItems.ShipmentId.Integer":{"type":"integer","title":"Orders.Post.Api.V.Version.Shipment.ShipmentId.UpdateLineItems.ShipmentId.Integer"},"Orders.ShipmentLineItemsViewModel":{"type":"object","properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"is_manually_assigned_lot":{"type":"boolean","description":"Indicates whether the lot was manually assigned. When true, ShipBob treats all lot assignments in the shipment as manually reviewed. Must be the same value for all line items in the request."},"lot_date":{"type":["string","null"],"description":"Expiration or manufacturing date of the lot"},"lot_number":{"type":["string","null"],"description":"Lot number of the inventory item"},"quantity":{"type":"integer","description":"Quantity of the inventory item in the shipment"}},"required":["inventory_id","quantity"],"title":"Orders.ShipmentLineItemsViewModel"},"Orders.UpdateLineItemsRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentLineItemsViewModel"},"description":"Complete list of line items for the shipment. Must include all line items — partial updates are not supported"}},"required":["items"],"title":"Orders.UpdateLineItemsRequest"},"Orders.ShipmentLineItemResponse":{"type":"object","properties":{"action":{"type":["string","null"],"description":"The action applied to this line item during the update"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"new_value":{"type":["string","null"],"description":"The new value of the field after the update"},"previous_value":{"type":["string","null"],"description":"The previous value of the field before the update"}},"title":"Orders.ShipmentLineItemResponse"},"Orders.ShipmentLineItemsApiResponse":{"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/Orders.ErrorResponse"},{"type":"null"}],"description":"Error details if the update was not successful"},"id":{"type":"integer","format":"int64","description":"Unique identifier of the shipment"},"is_success":{"type":"boolean","description":"Indicates whether the update was successful"},"shipment_line_items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ShipmentLineItemResponse"},"description":"List of line item changes applied to the shipment"}},"title":"Orders.ShipmentLineItemsApiResponse"},"Orders.Post.Api.V.Version.Shipment.ShipmentId.UpdateLineItemsBySku.ShipmentId.Integer":{"type":"integer","title":"Orders.Post.Api.V.Version.Shipment.ShipmentId.UpdateLineItemsBySku.ShipmentId.Integer"},"Orders.ShipmentLineItemsBySkuViewModel":{"type":"object","properties":{"is_manually_assigned_lot":{"type":"boolean","description":"Indicates whether the lot was manually assigned. When true, ShipBob treats all lot assignments in the shipment as manually reviewed. Must be the same value for all line items in the request."},"lot_date":{"type":["string","null"],"description":"Expiration or manufacturing date of the lot"},"lot_number":{"type":["string","null"],"description":"Lot number of the inventory item"},"quantity":{"type":"integer","description":"Quantity of the inventory item in the shipment"},"sku":{"type":"string","description":"SKU of the inventory item. Matches both the ShipBob variant SKU and the channel seller SKU. A SKU that resolves to a bundle or to multiple inventory items is rejected — use the inventory_id-based endpoint (:updateLineItems) for those."}},"required":["quantity","sku"],"title":"Orders.ShipmentLineItemsBySkuViewModel"},"Orders.UpdateLineItemsBySkuRequest":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentLineItemsBySkuViewModel"},"description":"Complete list of line items for the shipment, identified by SKU. Must include all line items — partial updates are not supported"}},"required":["items"],"title":"Orders.UpdateLineItemsBySkuRequest"},"Orders.Post.Api.V.Version.Shipment.ShipmentId.AssignFulfillmentCenter.ShipmentId.Integer":{"type":"integer","title":"Orders.Post.Api.V.Version.Shipment.ShipmentId.AssignFulfillmentCenter.ShipmentId.Integer"},"Orders.AssignFulfillmentCenterRequest":{"type":"object","properties":{"fulfillment_center_id":{"type":"integer","description":"Unique identifier of the fulfillment center to assign to the shipment. The caller must have access to it and it must be active."}},"required":["fulfillment_center_id"],"title":"Orders.AssignFulfillmentCenterRequest"},"Orders.BulkUpdateShippingServiceRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Reason for updating the shipping service"},"requested_shipping_service_id":{"type":"integer","description":"The `service_level.id` value from an `orders-get-shipping-method` result (the nested `service_level` object's `id`, for example 2 for Expedited). Do not pass the shipping method's top-level `id`."},"shipment_ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"List of shipment IDs to update the shipping service for"}},"required":["reason","requested_shipping_service_id","shipment_ids"],"title":"Orders.BulkUpdateShippingServiceRequest"},"Orders.IApiDetailResponse":{"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/Orders.ErrorResponse"},{"type":"null"}],"description":"Error details if the operation was not successful"},"id":{"type":"integer","format":"int64","description":"Unique identifier of the shipment"},"is_success":{"type":"boolean","description":"Indicates whether the operation was successful for this shipment"}},"title":"Orders.IApiDetailResponse"},"Orders.SummaryResponse":{"type":"object","properties":{"failed":{"type":"integer","description":"Number of shipments that failed to update"},"successful":{"type":"integer","description":"Number of shipments that were updated successfully"},"total":{"type":"integer","description":"Total number of shipments included in the bulk operation"}},"title":"Orders.SummaryResponse"},"Orders.BulkActionApiResponse":{"type":"object","properties":{"results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.IApiDetailResponse"},"description":"Per-shipment results of the bulk operation"},"summary":{"$ref":"#/components/schemas/Orders.SummaryResponse","description":"Summary of the bulk operation results"}},"required":["summary"],"title":"Orders.BulkActionApiResponse"},"Orders.BulkPlaceOnHoldRequest":{"type":"object","properties":{"reserve_inventory":{"type":"boolean","default":true,"description":"When true (default), inventory stays committed and an allocation hold is placed. When false, the committed inventory is deallocated (the dashboard's 'Unreserve' option)."},"shipment_ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Shipments to place on hold. Must contain at least one id."}},"required":["shipment_ids"],"title":"Orders.BulkPlaceOnHoldRequest"},"Orders.BulkReleaseHoldRequest":{"type":"object","properties":{"shipment_ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Shipments to release from hold. Must contain at least one id."}},"required":["shipment_ids"],"title":"Orders.BulkReleaseHoldRequest"},"Orders.ReleaseHoldApiResponse":{"type":"object","properties":{"error":{"oneOf":[{"$ref":"#/components/schemas/Orders.ErrorResponse"},{"type":"null"}]},"id":{"type":"integer","format":"int64","description":"Shipment id"},"is_still_on_hold_due_to_other_reasons":{"type":"boolean","description":"True when the shipment remains on hold for operational (non-merchant-initiated) reasons after the manual/auto-processing-pause holds were released."},"is_success":{"type":"boolean","description":"Whether the release succeeded for this shipment"}},"title":"Orders.ReleaseHoldApiResponse"},"Orders.ReleaseHoldBulkActionApiResponse":{"type":"object","properties":{"results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ReleaseHoldApiResponse"},"description":"Per-shipment release results"},"summary":{"$ref":"#/components/schemas/Orders.SummaryResponse","description":"Summary of the bulk operation results"}},"required":["summary"],"title":"Orders.ReleaseHoldBulkActionApiResponse"},"Orders.Post.Api.Order.OrderId.Cancel.OrderId.Integer":{"type":"integer","title":"Orders.Post.Api.Order.OrderId.Cancel.OrderId.Integer"},"Orders.Post.Api.Order.OrderId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Post.Api.Order.OrderId.Cancel.Shipbob.Channel.Id.Integer"},"Orders.CancellationResult":{"type":"string","enum":["Success","Failure","PartialSuccess"],"title":"Orders.CancellationResult"},"Orders.CanceledOrderViewModel":{"type":"object","properties":{"canceled_shipment_results":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.CanceledShipmentViewModel"},"description":"Results of canceling the shipments associated with the order"},"order":{"$ref":"#/components/schemas/Orders.OrderViewModel"},"order_id":{"type":"integer","description":"The ID of the canceled order"},"status":{"$ref":"#/components/schemas/Orders.CancellationResult"}},"title":"Orders.CanceledOrderViewModel"},"Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object"},"Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object"},"Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.ShipmentId.Integer":{"type":"integer","title":"Orders.Post.Api.Shipment.ShipmentId.Cancel.ShipmentId.Integer"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Post.Api.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"},"Orders.Get.Api.Shippingmethod.Page.Integer":{"type":"integer","minimum":0,"maximum":2147483647,"title":"Orders.Get.Api.Shippingmethod.Page.Integer"},"Orders.Get.Api.Shippingmethod.Limit.Integer":{"type":"integer","minimum":1,"maximum":250,"title":"Orders.Get.Api.Shippingmethod.Limit.Integer"},"Orders.ServiceLevelDetailViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id for the service level"},"name":{"type":["string","null"],"description":"The name or title of the service level"}},"title":"Orders.ServiceLevelDetailViewModel"},"Orders.ShipMethodDetailViewModel":{"type":"object","properties":{"active":{"type":"boolean","description":"Indicates if the shipping method is active"},"default":{"type":"boolean","description":"Indicates the shipping method is a ShipBob default shipping method."},"id":{"type":"integer","description":"Unique id for shipping method."},"name":{"type":["string","null"],"description":"Name of the ship method as selected by the merchant and saved in ShipBob’s database (i.e. “ground”). Corresponds to the shipping_method field in the Orders API."},"service_level":{"$ref":"#/components/schemas/Orders.ServiceLevelDetailViewModel"}},"title":"Orders.ShipMethodDetailViewModel"},"Orders.ShipMethodDetailViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipMethodDetailViewModel"},"title":"Orders.ShipMethodDetailViewModelArray"},"Orders.Get.Api.Shippingmethod.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Shippingmethod.Bad.Request.Object"},"Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.OrderId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.OrderId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.ShipmentId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object"},"Orders.Get.Api.Order.OrderId.Shipment.OrderId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.OrderId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.Shipbob.Channel.Id.Integer"},"Orders.InternalShipmentViewModel":{"type":"object","properties":{"actual_fulfillment_date":{"type":["string","null"],"format":"date-time","description":"The datetime of ShipBob’s completion of the fulfillment operation as promised.\r\nCurrently, this means the shipment has been picked, packed, and label has been printed."},"created_date":{"type":"string","format":"date-time","description":"Date this shipment was created"},"delivery_date":{"type":["string","null"],"format":"date-time","description":"The datetime of Shipment delivered to customer."},"estimated_fulfillment_date":{"type":["string","null"],"format":"date-time","description":"The datetime of ShipBob’s commitment for completing\r\nthe shipment and handing to the carrier for delivery."},"estimated_fulfillment_date_status":{"$ref":"#/components/schemas/Orders.FulfillmentStatus"},"gift_message":{"type":["string","null"],"maxLength":500,"description":"Gift message associated with the shipment"},"id":{"type":"integer","description":"Unique id of the shipment"},"insurance_value":{"type":["number","null"],"format":"double","description":"Monetary amount that this shipment was insured for"},"invoice_amount":{"type":["number","null"],"format":"double","description":"Monetary amount that was invoiced for this shipment"},"invoice_currency_code":{"type":["string","null"]},"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated."},"last_tracking_update_at":{"type":["string","null"],"format":"date-time","description":"Timestamp for the last time this shipment had a tracking update"},"last_update_at":{"type":["string","null"],"format":"date-time","description":"Date this shipment was last updated"},"location":{"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"measurements":{"$ref":"#/components/schemas/Orders.MeasurementsViewModel"},"order_id":{"type":"integer","description":"Id of the order this shipment belongs to"},"package_material_type":{"$ref":"#/components/schemas/Orders.PackageMaterialType"},"parent_cartons":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ParentCartonViewModel"},"description":"Carton information for this shipment"},"products":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"description":"Information about the products contained in this shipment"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientViewModel"},"reference_id":{"type":["string","null"],"description":"Client-defined external unique id of the order this shipment belongs to"},"require_signature":{"type":"boolean","description":"If a shipment requires signature"},"ship_option":{"type":["string","null"],"description":"Name of the shipping option used for this shipment"},"status":{"$ref":"#/components/schemas/Orders.OrderStatusEnum"},"status_details":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Orders.StatusDetailViewModel"},"description":"Additional details about the shipment status"},"tracking":{"$ref":"#/components/schemas/Orders.TrackingViewModel"},"store_order_id":{"type":["string","null"],"description":"Unique store order id of the shipment"}},"title":"Orders.InternalShipmentViewModel"},"OrdersGetApiOrderOrderIdShipmentOkOneOfArrayItems":{"oneOf":[{"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}],"description":"Information about a shipment","title":"OrdersGetApiOrderOrderIdShipmentOkOneOfArrayItems"},"Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray":{"type":"array","items":{"$ref":"#/components/schemas/OrdersGetApiOrderOrderIdShipmentOkOneOfArrayItems"},"title":"Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray"},"Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.OrderId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.OrderId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.ShipmentId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.ShipmentId.Integer":{"type":"integer","title":"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.ShipmentId.Integer"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OrderId.Integer":{"type":"integer","title":"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OrderId.Integer"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"},"Orders.Get.Api.Shipment.ShipmentId.Logs.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.Shipment.ShipmentId.Logs.ShipmentId.Integer"},"Orders.Get.Api.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer"},"Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OrderId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OrderId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.ShipmentId.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.OrderId.Integer":{"type":"integer","title":"Orders.Get.Api.Order.OrderId.StoreOrderJson.OrderId.Integer"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String":{"type":"string","title":"Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object"},"Orders.Get.Api.Order.Cancelled.Page.Integer":{"type":"integer","minimum":1,"maximum":2147483647,"title":"Orders.Get.Api.Order.Cancelled.Page.Integer"},"Orders.Get.Api.Order.Cancelled.Limit.Integer":{"type":"integer","minimum":1,"maximum":250,"title":"Orders.Get.Api.Order.Cancelled.Limit.Integer"},"Orders.Get.Api.Order.Cancelled.IsTrackingUploaded.Boolean":{"type":"boolean","title":"Orders.Get.Api.Order.Cancelled.IsTrackingUploaded.Boolean"},"Orders.OrderShipmentIdsViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique id of the order"},"order_number":{"type":["string","null"],"description":"User-friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId\r\nwill be used"},"reference_id":{"type":["string","null"],"description":"Client-defined external unique id of the order. Orders without a reference id are excluded from this endpoint."},"shipment_ids":{"type":["array","null"],"items":{"type":"integer","format":"int64"},"description":"Shipments Ids affiliated with the order"}},"title":"Orders.OrderShipmentIdsViewModel"},"Orders.OrderShipmentIdsViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.OrderShipmentIdsViewModel"},"title":"Orders.OrderShipmentIdsViewModelArray"},"Orders.Get.Api.Order.Cancelled.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Orders.Get.Api.Order.Cancelled.Bad.Request.Object"},"Orders.BulkUpdateInstructionsRequest":{"type":"object","properties":{"packing_instruction":{"type":["string","null"],"description":"Packing instructions for the shipments. Omit this field to leave the existing packing instructions unchanged; send an empty string to clear them. At least one of `packing_instruction` or `sku_instruction` must be provided with a non-null value. Leading and trailing whitespace is removed, and the 500-character limit applies to what remains."},"shipment_ids":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Shipment IDs to update the instructions for. Duplicates are ignored, and the 250 maximum applies to the de-duplicated list."},"sku_instruction":{"type":["string","null"],"description":"Special SKU instructions for the shipments. Omit this field to leave the existing SKU instructions unchanged; send an empty string to clear them. At least one of `packing_instruction` or `sku_instruction` must be provided with a non-null value. Leading and trailing whitespace is removed, and the 500-character limit applies to what remains."}},"required":["shipment_ids"],"title":"Orders.BulkUpdateInstructionsRequest"},"ProductsBaseProductRequestModelTypeId":{"type":"string","enum":["1","2"],"description":"The product type ID (1 = Regular, 2 = Bundle)","title":"ProductsBaseProductRequestModelTypeId"},"Products.AdditionalHazmatAttributesRequestModel":{"type":"object","properties":{"charge_state_percentage":{"type":["number","null"],"format":"double"},"container_metal":{"type":["boolean","null"],"deprecated":true},"container_type":{"type":["string","null"]},"lithium_battery_packaging":{"type":["string","null"]},"lithium_battery_type":{"type":["string","null"]},"magnet":{"type":["boolean","null"]},"net_volume":{"type":["number","null"],"format":"double"},"net_weight":{"type":["number","null"],"format":"double"}},"title":"Products.AdditionalHazmatAttributesRequestModel"},"Products.BundleDefinitionRequestModel":{"type":"object","properties":{"quantity":{"type":"integer"},"variant_id":{"type":"integer","format":"int64"}},"title":"Products.BundleDefinitionRequestModel"},"Products.BaseChannelMetadataRequestModel":{"type":"object","properties":{"channel_id":{"type":["integer","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]}},"description":"Standard Channel Metadata Record to store SellerSKU for a Sales Channel","title":"Products.BaseChannelMetadataRequestModel"},"ProductsBaseProductVariantRequestModelV8ChannelMetadataItems":{"oneOf":[{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}],"title":"ProductsBaseProductVariantRequestModelV8ChannelMetadataItems"},"Products.CustomsRequestModelV8":{"type":"object","properties":{"country_code_of_origin":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code where the product was manufactured (e.g., 'US', 'CN', 'MX')"},"description":{"type":["string","null"],"description":"Product description for customs documentation"},"hs_tariff_code":{"type":["string","null"],"description":"Harmonized System tariff code used for international customs classification (6-10 digits)"},"is321_eligible":{"type":"boolean","description":"Flag indicating eligibility for Section 321 de minimis exemption (imports under $800 to US)"},"value":{"type":["number","null"],"format":"double","description":"Declared customs value of the product for international shipping"}},"title":"Products.CustomsRequestModelV8"},"Products.DimensionRequestModel":{"type":"object","properties":{"height":{"type":"number","format":"double"},"length":{"type":"number","format":"double"},"width":{"type":"number","format":"double"}},"title":"Products.DimensionRequestModel"},"Products.SerialScanRequestModel":{"type":"object","properties":{"exact_character_length":{"type":["integer","null"]},"is_enabled":{"type":"boolean"},"prefix":{"type":["string","null"]},"suffix":{"type":["string","null"]}},"title":"Products.SerialScanRequestModel"},"Products.FulfillmentSettingsRequestModel":{"type":"object","properties":{"dangerous_goods":{"type":"boolean"},"is_bpm_parcel":{"type":"boolean"},"is_case_pick":{"type":"boolean"},"msds_url":{"type":["string","null"]},"requires_prop65":{"type":"boolean"},"serial_scan":{"$ref":"#/components/schemas/Products.SerialScanRequestModel"}},"title":"Products.FulfillmentSettingsRequestModel"},"Products.LotInformationRequestModel":{"type":"object","properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":["integer","null"]}},"title":"Products.LotInformationRequestModel"},"Products.ReturnPreferencesRequestModel":{"type":"object","properties":{"backup_action_id":{"type":["integer","null"]},"instructions":{"type":["string","null"]},"primary_action_id":{"type":"integer"},"return_to_sender_backup_action_id":{"type":["integer","null"]},"return_to_sender_primary_action_id":{"type":["integer","null"]}},"title":"Products.ReturnPreferencesRequestModel"},"ProductsBaseProductVariantRequestModelV8StatusId":{"type":"string","enum":["0","1"],"description":"The status ID of the variant (0 = Active, 1 = Inactive)","title":"ProductsBaseProductVariantRequestModelV8StatusId"},"Products.BarcodeRequestModel":{"type":"object","properties":{"sticker_url":{"type":["string","null"],"description":"URL to download or view a printable barcode sticker"},"value":{"type":["string","null"],"description":"The barcode value (e.g., UPC, EAN, GTIN, or other barcode format)"}},"title":"Products.BarcodeRequestModel"},"Products.CreateProductVariantRequestModelV8":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesRequestModel","description":"Additional hazardous material attributes for variants containing lithium batteries or other regulated materials"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"description":"For bundle products, defines which variants and quantities make up the bundle"},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsBaseProductVariantRequestModelV8ChannelMetadataItems"},"description":"Channel-specific metadata for different sales platforms (Amazon, Shopify, BigCommerce, etc.)"},"customs":{"$ref":"#/components/schemas/Products.CustomsRequestModelV8","description":"Customs information for international shipping including HS tariff code, country of origin, and declared value"},"dimension":{"$ref":"#/components/schemas/Products.DimensionRequestModel","description":"The physical dimensions (length, width, height) of the variant"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsRequestModel","description":"Fulfillment settings including Prop 65 requirements, dangerous goods, serial scanning, and case pick settings"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number (GTIN) for the variant"},"is_digital":{"type":"boolean","description":"Indicates whether this is a digital product that requires no physical fulfillment"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationRequestModel","description":"Lot tracking information including whether the variant is lot-tracked and minimum shelf life"},"name":{"type":["string","null"],"description":"The name of the variant"},"packaging_material_type_id":{"type":["integer","null"],"description":"The ID of the packaging material type (e.g., Box, Envelope, Poly Mailer)"},"packaging_requirement_id":{"type":["integer","null"],"description":"The ID of the packaging requirement for the variant (e.g., IsFragile, RequiresBubbleWrap)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesRequestModel","description":"Return handling preferences including primary and backup actions for returns"},"sku":{"type":["string","null"],"description":"The unique stock keeping unit (SKU) for the variant"},"status_id":{"$ref":"#/components/schemas/ProductsBaseProductVariantRequestModelV8StatusId","description":"The status ID of the variant (0 = Active, 1 = Inactive)"},"upc":{"type":["string","null"],"description":"The Universal Product Code (UPC) for the variant"},"weight":{"type":"number","format":"double","description":"The weight of the variant in ounces"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"description":"Array of barcode values for the variant"}},"title":"Products.CreateProductVariantRequestModelV8"},"Products.CreateProductRequestModelV8":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The name of the product"},"taxonomy_id":{"type":["integer","null"],"description":"The taxonomy ID for categorizing the product"},"type_id":{"$ref":"#/components/schemas/ProductsBaseProductRequestModelTypeId","description":"The product type ID (1 = Regular, 2 = Bundle)"},"is_quarantine":{"type":"boolean","description":"Flag indicating whether the product should be created in quarantine status"},"variants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV8"},"description":"List of variants to create with the product. At least one variant is required. Each variant must have a unique SKU."}},"title":"Products.CreateProductRequestModelV8"},"Products.TaxonomyInformationViewModel":{"type":"object","properties":{"id":{"type":["integer","null"],"description":"Unique identifier for the taxonomy"},"name":{"type":["string","null"],"description":"Name of this taxonomy category"},"parent_id":{"type":["integer","null"],"description":"ID of the parent category in the taxonomy hierarchy"},"parent_name":{"type":["string","null"],"description":"Name of the parent category in the taxonomy hierarchy"},"path":{"type":["string","null"],"description":"Full hierarchical path of the taxonomy category (e.g., 'Electronics > Computers > Laptops')"}},"title":"Products.TaxonomyInformationViewModel"},"Products.AdditionalHazmatAttributesViewModel":{"type":"object","properties":{"charge_state_percentage":{"type":["number","null"],"format":"double"},"container_metal":{"type":["boolean","null"],"deprecated":true},"container_type":{"type":["string","null"]},"lithium_battery_packaging":{"type":["string","null"]},"lithium_battery_type":{"type":["string","null"]},"magnet":{"type":["boolean","null"]},"net_volume":{"type":["number","null"],"format":"double"},"net_weight":{"type":["number","null"],"format":"double"}},"title":"Products.AdditionalHazmatAttributesViewModel"},"Products.AssociatedBundlesViewModel":{"type":"object","properties":{"product_id":{"type":"integer","format":"int64"},"product_name":{"type":["string","null"]},"quantity":{"type":"integer"},"variant_id":{"type":"integer","format":"int64"},"variant_sku":{"type":["string","null"]}},"title":"Products.AssociatedBundlesViewModel"},"Products.BundleDefinitionViewModel":{"type":"object","properties":{"product_id":{"type":"integer","format":"int64"},"quantity":{"type":"integer"},"variant_id":{"type":"integer","format":"int64"},"variant_name":{"type":["string","null"]},"variant_sku":{"type":["string","null"]}},"title":"Products.BundleDefinitionViewModel"},"Products.CustomsViewModelV8":{"type":"object","properties":{"country_code_of_origin":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code where the product was manufactured (e.g., 'US', 'CN', 'MX')"},"currency":{"type":["string","null"],"description":"ISO 4217 currency code for the declared value (e.g., 'USD', 'EUR', 'GBP')"},"description":{"type":["string","null"],"description":"Product description for customs documentation"},"hs_tariff_code":{"type":["string","null"],"description":"Harmonized System tariff code used for international customs classification (6-10 digits)"},"is321_eligible":{"type":"boolean","description":"Flag indicating eligibility for Section 321 de minimis exemption (imports under $800 to US)"},"value":{"type":["number","null"],"format":"double","description":"Declared customs value of the product for international shipping"}},"title":"Products.CustomsViewModelV8"},"Products.DimensionViewModel":{"type":"object","properties":{"height":{"type":"number","format":"double","description":"Height of the product"},"is_locked":{"type":"boolean","description":"Flag indicating whether dimensions are locked and cannot be automatically recalculated by the system"},"length":{"type":"number","format":"double","description":"Length of the product"},"source":{"type":["string","null"],"description":"Source of the dimension data (e.g., 'User', 'System', 'Warehouse')"},"unit":{"type":["string","null"],"description":"Unit of measurement for dimensions (e.g., 'in', 'cm')"},"width":{"type":"number","format":"double","description":"Width of the product"}},"title":"Products.DimensionViewModel"},"Products.SerialScanViewModel":{"type":"object","properties":{"exact_character_length":{"type":["integer","null"]},"is_enabled":{"type":"boolean"},"prefix":{"type":["string","null"]},"suffix":{"type":["string","null"]}},"title":"Products.SerialScanViewModel"},"Products.FulfillmentSettingsViewModel":{"type":"object","properties":{"dangerous_goods":{"type":"boolean","description":"Flag indicating whether the product is classified as dangerous goods (hazmat) requiring special handling"},"is_bpm_parcel":{"type":"boolean","description":"Flag indicating whether this product qualifies for Business Parcel Manager (BPM) parcel shipping"},"is_case_pick":{"type":"boolean","description":"Flag indicating whether this product should be picked by the case rather than individual units"},"msds_url":{"type":["string","null"],"description":"URL to the Material Safety Data Sheet (MSDS) for hazardous materials"},"requires_prop65":{"type":"boolean","description":"Flag indicating California Proposition 65 warning label requirement for products containing chemicals known to cause cancer or reproductive harm"},"serial_scan":{"$ref":"#/components/schemas/Products.SerialScanViewModel","description":"Serial number scanning configuration for tracking individual units"}},"title":"Products.FulfillmentSettingsViewModel"},"Products.InventoryViewModel":{"type":"object","properties":{"inventory_id":{"type":["integer","null"]},"on_hand_qty":{"type":"integer"}},"title":"Products.InventoryViewModel"},"Products.LotInformationViewModel":{"type":"object","properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":["integer","null"]}},"title":"Products.LotInformationViewModel"},"Products.MergedChildrenViewModel":{"type":"object","properties":{"channel_ids":{"type":["array","null"],"items":{"type":"integer","format":"int64"}},"completed_at":{"type":"string","format":"date-time"},"inventory_id":{"type":["integer","null"],"format":"int64"},"variant_id":{"type":"integer","format":"int64"},"variant_name":{"type":["string","null"]}},"title":"Products.MergedChildrenViewModel"},"Products.EnumViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":["string","null"]}},"title":"Products.EnumViewModel"},"Products.ReturnPreferencesViewModel":{"type":"object","properties":{"backup_action":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Backup action to take if primary action cannot be completed"},"instructions":{"type":["string","null"],"description":"Special instructions for handling returned items"},"primary_action":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Primary action to take when product is returned by customer (e.g., 'Restock', 'Dispose', 'Return to Sender')"},"return_to_sender_backup_action":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Backup action for undeliverable packages if primary action cannot be completed"},"return_to_sender_primary_action":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Primary action for undeliverable packages that are returned to sender"}},"title":"Products.ReturnPreferencesViewModel"},"Products.WeightViewModel":{"type":"object","properties":{"unit":{"type":["string","null"],"description":"Unit of measurement for weight (e.g., 'lb', 'oz', 'kg', 'g')"},"weight":{"type":"number","format":"double","description":"Weight value of the product"}},"title":"Products.WeightViewModel"},"Products.BarcodeViewModel":{"type":"object","properties":{"sticker_url":{"type":["string","null"],"description":"URL to download or view a printable barcode sticker"},"value":{"type":["string","null"],"description":"The barcode value (e.g., UPC, EAN, GTIN, or other barcode format)"}},"title":"Products.BarcodeViewModel"},"Products.ChannelMetadataViewModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]}},"title":"Products.ChannelMetadataViewModel"},"Products.AmazonChannelMetadataViewModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]},"asin":{"type":["string","null"]},"fnsku":{"type":["string","null"]},"fulfillment_channel":{"type":["string","null"]}},"title":"Products.AmazonChannelMetadataViewModel"},"Products.BigCommerceChannelMetadataViewModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]},"platform_product_id":{"type":["integer","null"],"format":"int64"},"platform_variant_id":{"type":["integer","null"],"format":"int64"}},"title":"Products.BigCommerceChannelMetadataViewModel"},"Products.ShopifyChannelMetadataViewModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]}},"title":"Products.ShopifyChannelMetadataViewModel"},"ProductsVariantViewModelV8ChannelMetadataItems":{"oneOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.AmazonChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataViewModel"}],"title":"ProductsVariantViewModelV8ChannelMetadataItems"},"Products.VariantViewModelV8":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel","description":"Additional hazardous materials attributes for lithium batteries and dangerous goods"},"associated_bundles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"description":"List of bundle products that include this variant as a component"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"description":"If this variant is a bundle, defines which variants and quantities make up the bundle"},"created_on":{"type":"string","format":"date-time","description":"Timestamp when the variant was created"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModelV8","description":"Customs and international shipping information (tariff codes, country of origin, declared value)"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel","description":"Physical dimensions of the variant (length, width, height)"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel","description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)"},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - standardized product identifier"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel","description":"Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels."},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)"},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel","description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements"},"merge_children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"description":"List of variants that have been merged into this variant"},"name":{"type":["string","null"],"description":"Variant name or descriptor"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Type of packaging material used for this variant (ID and name)"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Special packaging requirements for this variant (ID and name)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel","description":"Customer return handling preferences including primary and backup actions"},"reviews_pending":{"type":["array","null"],"items":{"type":"string"},"description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)"},"sku":{"type":["string","null"],"description":"Stock Keeping Unit - unique identifier for the variant used in inventory management"},"status":{"type":["string","null"],"description":"Current status of the variant (e.g., 'Active', 'Inactive')"},"upc":{"type":["string","null"],"description":"Universal Product Code - 12-digit barcode identifier"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the variant was last updated"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel","description":"Weight of the variant including unit of measure"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeViewModel"},"description":"List of barcodes associated with this variant (UPC, EAN, etc.)"},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsVariantViewModelV8ChannelMetadataItems"},"description":"Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)"}},"title":"Products.VariantViewModelV8"},"Products.ComplianceViewModel":{"type":"object","properties":{"category":{"type":["array","null"],"items":{"type":"string"}},"reasons":{"type":["array","null"],"items":{"type":"string"}},"status":{"type":["string","null"]}},"title":"Products.ComplianceViewModel"},"Products.VariantInternalViewModelV8":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel","description":"Additional hazardous materials attributes for lithium batteries and dangerous goods"},"associated_bundles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"description":"List of bundle products that include this variant as a component"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"description":"If this variant is a bundle, defines which variants and quantities make up the bundle"},"created_on":{"type":"string","format":"date-time","description":"Timestamp when the variant was created"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModelV8","description":"Customs and international shipping information (tariff codes, country of origin, declared value)"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel","description":"Physical dimensions of the variant (length, width, height)"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel","description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)"},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - standardized product identifier"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel","description":"Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels."},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)"},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel","description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements"},"merge_children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"description":"List of variants that have been merged into this variant"},"name":{"type":["string","null"],"description":"Variant name or descriptor"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Type of packaging material used for this variant (ID and name)"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Special packaging requirements for this variant (ID and name)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel","description":"Customer return handling preferences including primary and backup actions"},"reviews_pending":{"type":["array","null"],"items":{"type":"string"},"description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)"},"sku":{"type":["string","null"],"description":"Stock Keeping Unit - unique identifier for the variant used in inventory management"},"status":{"type":["string","null"],"description":"Current status of the variant (e.g., 'Active', 'Inactive')"},"upc":{"type":["string","null"],"description":"Universal Product Code - 12-digit barcode identifier"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the variant was last updated"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel","description":"Weight of the variant including unit of measure"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeViewModel"},"description":"List of barcodes associated with this variant (UPC, EAN, etc.)"},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsVariantViewModelV8ChannelMetadataItems"},"description":"Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)"},"compliance":{"$ref":"#/components/schemas/Products.ComplianceViewModel"}},"title":"Products.VariantInternalViewModelV8"},"ProductsProductViewModelV8VariantsItems":{"oneOf":[{"$ref":"#/components/schemas/Products.VariantViewModelV8"},{"$ref":"#/components/schemas/Products.VariantInternalViewModelV8"}],"title":"ProductsProductViewModelV8VariantsItems"},"Products.ProductViewModelV8":{"type":"object","properties":{"created_on":{"type":"string","format":"date-time","description":"Timestamp when the product was created"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the product"},"name":{"type":["string","null"],"description":"Product name"},"taxonomy":{"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel","description":"Product categorization information including category hierarchy"},"type":{"type":["string","null"],"description":"Product type (e.g., 'Regular' or 'Bundle')"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the product was last updated"},"user_id":{"type":"integer","format":"int64","description":"ID of the user who owns this product"},"variants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsProductViewModelV8VariantsItems"},"description":"List of variants belonging to this product. Each variant represents a specific SKU."}},"title":"Products.ProductViewModelV8"},"Products.Get.Api.V5.Product.Search.String":{"type":"string","title":"Products.Get.Api.V5.Product.Search.String"},"Products.Get.Api.V5.Product.Barcode.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.Barcode.Int"},"Products.Get.Api.V5.Product.Barcodes.List.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.Barcodes.List.String"},"Products.Get.Api.V5.Product.CategoryIds.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.CategoryIds.List.Int"},"Products.Get.Api.V5.Product.ChannelIds.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.ChannelIds.List.Int"},"Products.Get.Api.V5.Product.HasDigitalVariants.Boolean":{"description":"Any type","title":"Products.Get.Api.V5.Product.HasDigitalVariants.Boolean"},"Products.Get.Api.V5.Product.HasVariants.Boolean":{"description":"Any type","title":"Products.Get.Api.V5.Product.HasVariants.Boolean"},"Products.Get.Api.V5.Product.InventoryId.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.InventoryId.List.Int"},"202607ProductGetParametersIsInventorySyncEnabled":{"type":"object","properties":{},"title":"202607ProductGetParametersIsInventorySyncEnabled"},"Products.Get.Api.V5.Product.LastUpdatedTimestamp.DateTime":{"description":"Any type","title":"Products.Get.Api.V5.Product.LastUpdatedTimestamp.DateTime"},"Products.Get.Api.V5.Product.LegacyIds.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.LegacyIds.List.Int"},"Products.Get.Api.V5.Product.Name.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.Name.String"},"Products.Get.Api.V5.Product.OnHand.Integer":{"description":"Any type","title":"Products.Get.Api.V5.Product.OnHand.Integer"},"Products.Get.Api.V5.Product.PlatformIds.List.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.PlatformIds.List.String"},"Products.Get.Api.V5.Product.ProductId.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.ProductId.List.Int"},"Products.Get.Api.V5.Product.ProductType.Integer":{"description":"Any type","title":"Products.Get.Api.V5.Product.ProductType.Integer"},"Products.Get.Api.V5.Product.ReviewsPending.List.ReviewsPendingType":{"description":"Any type","title":"Products.Get.Api.V5.Product.ReviewsPending.List.ReviewsPendingType"},"Products.Get.Api.V5.Product.SalesChannel.List.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.SalesChannel.List.String"},"Products.Get.Api.V5.Product.SellerSKU.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.SellerSKU.String"},"Products.Get.Api.V5.Product.SKU.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.SKU.String"},"Products.Get.Api.V5.Product.TaxonomyIds.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.TaxonomyIds.List.Int"},"Products.Get.Api.V5.Product.VariantId.List.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.VariantId.List.Int"},"Products.Get.Api.V5.Product.VariantStatus.String":{"description":"Any type","title":"Products.Get.Api.V5.Product.VariantStatus.String"},"Products.Get.Api.V5.Product.PageSize.Int":{"description":"Any type","title":"Products.Get.Api.V5.Product.PageSize.Int"},"Products.Get.Api.V5.Product.SortBy.String":{"type":"string","title":"Products.Get.Api.V5.Product.SortBy.String"},"Products.Get.Api.V5.Product.SortOrder.String":{"type":"string","title":"Products.Get.Api.V5.Product.SortOrder.String"},"Products.ProductViewModelV8PagedResponse":{"type":"object","properties":{"first":{"type":["string","null"]},"first_cursor":{"type":["string","null"]},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.ProductViewModelV8"}},"last":{"type":["string","null"]},"last_cursor":{"type":["string","null"]},"next":{"type":["string","null"]},"next_cursor":{"type":["string","null"]},"prev":{"type":["string","null"]},"prev_cursor":{"type":["string","null"]}},"title":"Products.ProductViewModelV8PagedResponse"},"Products.Get.Api.V5.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Products.Get.Api.V5.Product.Bad.Request.Object"},"Products.ProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":["integer","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]}},"title":"Products.ProblemDetails"},"Products.HttpValidationProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":["integer","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]},"errors":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"string"}}}},"title":"Products.HttpValidationProblemDetails"},"Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Get.Api.V5.Product.ProductId.ProductId.Integer"},"Products.Get.Api.V5.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Products.Get.Api.V5.Product.ProductId.Bad.Request.Object"},"Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Patch.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Patch.Api.V5.Product.ProductId.ProductId.Integer"},"Products.UpdateProductVariantRequestModelV8":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesRequestModel","description":"Additional hazardous material attributes for variants containing lithium batteries or other regulated materials"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"description":"For bundle products, defines which variants and quantities make up the bundle"},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsBaseProductVariantRequestModelV8ChannelMetadataItems"},"description":"Channel-specific metadata for different sales platforms (Amazon, Shopify, BigCommerce, etc.)"},"customs":{"$ref":"#/components/schemas/Products.CustomsRequestModelV8","description":"Customs information for international shipping including HS tariff code, country of origin, and declared value"},"dimension":{"$ref":"#/components/schemas/Products.DimensionRequestModel","description":"The physical dimensions (length, width, height) of the variant"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsRequestModel","description":"Fulfillment settings including Prop 65 requirements, dangerous goods, serial scanning, and case pick settings"},"gtin":{"type":["string","null"],"description":"The Global Trade Item Number (GTIN) for the variant"},"is_digital":{"type":"boolean","description":"Indicates whether this is a digital product that requires no physical fulfillment"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationRequestModel","description":"Lot tracking information including whether the variant is lot-tracked and minimum shelf life"},"name":{"type":["string","null"],"description":"The name of the variant"},"packaging_material_type_id":{"type":["integer","null"],"description":"The ID of the packaging material type (e.g., Box, Envelope, Poly Mailer)"},"packaging_requirement_id":{"type":["integer","null"],"description":"The ID of the packaging requirement for the variant (e.g., IsFragile, RequiresBubbleWrap)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesRequestModel","description":"Return handling preferences including primary and backup actions for returns"},"sku":{"type":["string","null"],"description":"The unique stock keeping unit (SKU) for the variant"},"status_id":{"$ref":"#/components/schemas/ProductsBaseProductVariantRequestModelV8StatusId","description":"The status ID of the variant (0 = Active, 1 = Inactive)"},"upc":{"type":["string","null"],"description":"The Universal Product Code (UPC) for the variant"},"weight":{"type":"number","format":"double","description":"The weight of the variant in ounces"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"description":"List of barcodes associated with this variant (UPC, EAN, etc.)"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant being updated. Required for update operations."}},"title":"Products.UpdateProductVariantRequestModelV8"},"Products.UpdateProductRequestModelV8":{"type":"object","properties":{"name":{"type":["string","null"],"description":"The name of the product"},"taxonomy_id":{"type":["integer","null"],"description":"The taxonomy ID for categorizing the product"},"type_id":{"$ref":"#/components/schemas/ProductsBaseProductRequestModelTypeId","description":"The product type ID (1 = Regular, 2 = Bundle)"},"id":{"type":"integer","format":"int64","description":"Unique reference ID for the product"},"variants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModelV8"},"description":"List of variants to update. Each variant must include an ID. Only provided fields will be updated."}},"title":"Products.UpdateProductRequestModelV8"},"Products.Get.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Get.Api.V5.Product.ProductId.Variants.ProductId.Integer"},"Products.VariantViewModelV8Array":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModelV8"},"title":"Products.VariantViewModelV8Array"},"Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object"},"Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Post.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Post.Api.V5.Product.ProductId.Variants.ProductId.Integer"},"Products.CreateProductVariantRequestModelV8Array":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV8"},"title":"Products.CreateProductVariantRequestModelV8Array"},"Products.Patch.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Patch.Api.V5.Product.ProductId.Variants.ProductId.Integer"},"Products.BaseAdditionalHazmatAttributesModel":{"type":"object","properties":{"charge_state_percentage":{"type":["number","null"],"format":"double"},"container_metal":{"type":["boolean","null"],"deprecated":true},"container_type":{"type":["string","null"]},"lithium_battery_packaging":{"type":["string","null"]},"lithium_battery_type":{"type":["string","null"]},"magnet":{"type":["boolean","null"]},"net_volume":{"type":["number","null"],"format":"double"},"net_weight":{"type":["number","null"],"format":"double"}},"title":"Products.BaseAdditionalHazmatAttributesModel"},"Products.BaseBundleDefinitionModel":{"type":"object","properties":{"quantity":{"type":"integer"},"variant_id":{"type":"integer","format":"int64"}},"title":"Products.BaseBundleDefinitionModel"},"Products.AmazonProductChannelMetadataModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]},"asin":{"type":["string","null"]},"fnsku":{"type":["string","null"]},"fulfillment_channel":{"type":["string","null"]}},"title":"Products.AmazonProductChannelMetadataModel"},"Products.BaseProductChannelMetadataModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]}},"title":"Products.BaseProductChannelMetadataModel"},"Products.BigCommerceProductChannelMetadataModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]},"platform_product_id":{"type":["integer","null"],"format":"int64"},"platform_variant_id":{"type":["integer","null"],"format":"int64"}},"title":"Products.BigCommerceProductChannelMetadataModel"},"Products.ShopifyProductChannelMetadataModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":["string","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]}},"title":"Products.ShopifyProductChannelMetadataModel"},"ProductsBaseProductVariantModelV8ChannelMetadataItems":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonProductChannelMetadataModel"},{"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"},{"$ref":"#/components/schemas/Products.BigCommerceProductChannelMetadataModel"},{"$ref":"#/components/schemas/Products.ShopifyProductChannelMetadataModel"}],"title":"ProductsBaseProductVariantModelV8ChannelMetadataItems"},"Products.BaseCustomsModelV8":{"type":"object","properties":{"country_code_of_origin":{"type":["string","null"]},"currency":{"type":["string","null"]},"description":{"type":["string","null"]},"hs_tariff_code":{"type":["string","null"]},"is321_eligible":{"type":"boolean"},"value":{"type":["number","null"],"format":"double"}},"title":"Products.BaseCustomsModelV8"},"Products.BaseDimensionModel":{"type":"object","properties":{"height":{"type":"number","format":"double","description":"Height of the product in inches"},"length":{"type":"number","format":"double","description":"Length of the product in inches"},"width":{"type":"number","format":"double","description":"Width of the product in inches"}},"title":"Products.BaseDimensionModel"},"Products.BaseSerialScanModel":{"type":"object","properties":{"exact_character_length":{"type":["integer","null"]},"is_enabled":{"type":"boolean"},"prefix":{"type":["string","null"]},"suffix":{"type":["string","null"]}},"title":"Products.BaseSerialScanModel"},"Products.BaseFulfillmentSettingsModel":{"type":"object","properties":{"dangerous_goods":{"type":"boolean","description":"Flag indicating whether the product is classified as dangerous goods (hazmat) requiring special handling"},"is_bpm_parcel":{"type":"boolean","description":"Flag indicating whether this product qualifies for Business Parcel Manager (BPM) parcel shipping"},"is_case_pick":{"type":"boolean","description":"Flag indicating whether this product should be picked by the case rather than individual units"},"msds_url":{"type":["string","null"],"description":"URL to the Material Safety Data Sheet (MSDS) for hazardous materials"},"requires_prop65":{"type":"boolean","description":"Flag indicating California Proposition 65 warning label requirement for products containing chemicals known to cause cancer or reproductive harm"},"serial_scan":{"$ref":"#/components/schemas/Products.BaseSerialScanModel","description":"Serial number scanning configuration for tracking individual units"}},"title":"Products.BaseFulfillmentSettingsModel"},"Products.BaseLotInformationModel":{"type":"object","properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":["integer","null"]}},"title":"Products.BaseLotInformationModel"},"Products.BaseReturnPreferencesModel":{"type":"object","properties":{"backup_action_id":{"type":["integer","null"],"description":"ID of backup action to take if primary action cannot be completed"},"instructions":{"type":["string","null"],"description":"Special instructions for handling returned items"},"primary_action_id":{"type":"integer","description":"ID of primary action to take when product is returned by customer (e.g., Restock, Dispose, Return to Sender)"},"return_to_sender_backup_action_id":{"type":["integer","null"],"description":"ID of backup action for undeliverable packages if primary action cannot be completed"},"return_to_sender_primary_action_id":{"type":["integer","null"],"description":"ID of primary action for undeliverable packages that are returned to sender"}},"title":"Products.BaseReturnPreferencesModel"},"Products.ReviewsPendingType":{"type":"string","enum":["0","1","2","3","4"],"title":"Products.ReviewsPendingType"},"Products.VariantStatus":{"type":"string","enum":["1","2","3"],"title":"Products.VariantStatus"},"Products.BarcodeModel":{"type":"object","properties":{"sticker_url":{"type":["string","null"]},"value":{"type":["string","null"]}},"title":"Products.BarcodeModel"},"Products.UpdateProductVariantModelV8":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.BaseAdditionalHazmatAttributesModel"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BaseBundleDefinitionModel"}},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsBaseProductVariantModelV8ChannelMetadataItems"}},"customs":{"$ref":"#/components/schemas/Products.BaseCustomsModelV8"},"dimension":{"$ref":"#/components/schemas/Products.BaseDimensionModel"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.BaseFulfillmentSettingsModel"},"gtin":{"type":["string","null"]},"is_digital":{"type":"boolean"},"lot_information":{"$ref":"#/components/schemas/Products.BaseLotInformationModel"},"name":{"type":["string","null"]},"packaging_material_type_id":{"type":["integer","null"]},"packaging_requirement_id":{"type":["integer","null"]},"return_preferences":{"$ref":"#/components/schemas/Products.BaseReturnPreferencesModel"},"reviews_pending":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.ReviewsPendingType"}},"sku":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/Products.VariantStatus"},"upc":{"type":["string","null"]},"weight":{"type":"number","format":"double"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeModel"}},"id":{"type":"integer","format":"int64"}},"title":"Products.UpdateProductVariantModelV8"},"Products.Post.Api.V5.Variant.VariantId.Merge.VariantId.Integer":{"type":"integer","format":"int64","title":"Products.Post.Api.V5.Variant.VariantId.Merge.VariantId.Integer"},"Products.MergeVariantRequestModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}},"title":"Products.MergeVariantRequestModel"},"Products.MergeVariantRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.MergeVariantRequestModel"},"title":"Products.MergeVariantRequestModelArray"},"Products.CustomsViewModel":{"type":"object","properties":{"country_code_of_origin":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code where the product was manufactured (e.g., 'US', 'CN', 'MX')"},"currency":{"type":["string","null"],"description":"ISO 4217 currency code for the declared value (e.g., 'USD', 'EUR', 'GBP')"},"description":{"type":["string","null"],"description":"Product description for customs documentation"},"hs_tariff_code":{"type":["string","null"],"description":"Harmonized System tariff code used for international customs classification (6-10 digits)"},"is321_eligible":{"type":"boolean","description":"Flag indicating eligibility for Section 321 de minimis exemption (imports under $800 to US)"},"value":{"type":["integer","null"],"description":"Declared customs value of the product for international shipping"}},"title":"Products.CustomsViewModel"},"ProductsVariantViewModelV5ChannelMetadataItems":{"oneOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.AmazonChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataViewModel"}],"title":"ProductsVariantViewModelV5ChannelMetadataItems"},"Products.VariantViewModelV5":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel","description":"Additional hazardous materials attributes for lithium batteries and dangerous goods"},"associated_bundles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"description":"List of bundle products that include this variant as a component"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"description":"If this variant is a bundle, defines which variants and quantities make up the bundle"},"created_on":{"type":"string","format":"date-time","description":"Timestamp when the variant was created"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModel","description":"Customs and international shipping information (tariff codes, country of origin, declared value)"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel","description":"Physical dimensions of the variant (length, width, height)"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel","description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)"},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - standardized product identifier"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel","description":"Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels."},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)"},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel","description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements"},"merge_children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"description":"List of variants that have been merged into this variant"},"name":{"type":["string","null"],"description":"Variant name or descriptor"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Type of packaging material used for this variant (ID and name)"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Special packaging requirements for this variant (ID and name)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel","description":"Customer return handling preferences including primary and backup actions"},"reviews_pending":{"type":["array","null"],"items":{"type":"string"},"description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)"},"sku":{"type":["string","null"],"description":"Stock Keeping Unit - unique identifier for the variant used in inventory management"},"status":{"type":["string","null"],"description":"Current status of the variant (e.g., 'Active', 'Inactive')"},"upc":{"type":["string","null"],"description":"Universal Product Code - 12-digit barcode identifier"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the variant was last updated"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel","description":"Weight of the variant including unit of measure"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeViewModel"},"description":"List of barcodes associated with this variant (UPC, EAN, etc.)"},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsVariantViewModelV5ChannelMetadataItems"},"description":"Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)"}},"title":"Products.VariantViewModelV5"},"Products.VariantInternalViewModelV5":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel","description":"Additional hazardous materials attributes for lithium batteries and dangerous goods"},"associated_bundles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"description":"List of bundle products that include this variant as a component"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"description":"If this variant is a bundle, defines which variants and quantities make up the bundle"},"created_on":{"type":"string","format":"date-time","description":"Timestamp when the variant was created"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModel","description":"Customs and international shipping information (tariff codes, country of origin, declared value)"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel","description":"Physical dimensions of the variant (length, width, height)"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel","description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)"},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - standardized product identifier"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel","description":"Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels."},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)"},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel","description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements"},"merge_children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"description":"List of variants that have been merged into this variant"},"name":{"type":["string","null"],"description":"Variant name or descriptor"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Type of packaging material used for this variant (ID and name)"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Special packaging requirements for this variant (ID and name)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel","description":"Customer return handling preferences including primary and backup actions"},"reviews_pending":{"type":["array","null"],"items":{"type":"string"},"description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)"},"sku":{"type":["string","null"],"description":"Stock Keeping Unit - unique identifier for the variant used in inventory management"},"status":{"type":["string","null"],"description":"Current status of the variant (e.g., 'Active', 'Inactive')"},"upc":{"type":["string","null"],"description":"Universal Product Code - 12-digit barcode identifier"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the variant was last updated"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel","description":"Weight of the variant including unit of measure"},"barcodes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BarcodeViewModel"},"description":"List of barcodes associated with this variant (UPC, EAN, etc.)"},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsVariantViewModelV5ChannelMetadataItems"},"description":"Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)"},"compliance":{"$ref":"#/components/schemas/Products.ComplianceViewModel"}},"title":"Products.VariantInternalViewModelV5"},"ProductsProductViewModelV5VariantsItems":{"oneOf":[{"$ref":"#/components/schemas/Products.VariantViewModelV5"},{"$ref":"#/components/schemas/Products.VariantInternalViewModelV5"}],"title":"ProductsProductViewModelV5VariantsItems"},"Products.ProductViewModelV5":{"type":"object","properties":{"created_on":{"type":"string","format":"date-time","description":"Timestamp when the product was created"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the product"},"name":{"type":["string","null"],"description":"Product name"},"taxonomy":{"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel","description":"Product categorization information including category hierarchy"},"type":{"type":["string","null"],"description":"Product type (e.g., 'Regular' or 'Bundle')"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the product was last updated"},"user_id":{"type":"integer","format":"int64","description":"ID of the user who owns this product"},"variants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsProductViewModelV5VariantsItems"},"description":"List of variants belonging to this product. Each variant represents a specific SKU."}},"title":"Products.ProductViewModelV5"},"Products.Post.Api.V5.Product.ProductId.MoveVariants.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Post.Api.V5.Product.ProductId.MoveVariants.ProductId.Integer"},"Products.VariantToMigrate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":["string","null"]}},"title":"Products.VariantToMigrate"},"Products.MigrateVariantRequestModel":{"type":"object","properties":{"category_id":{"type":["integer","null"]},"name":{"type":["string","null"]},"product_id":{"type":"integer","format":"int64"},"sub_category_id":{"type":["integer","null"]},"taxonomy_id":{"type":["integer","null"]},"variants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.VariantToMigrate"}}},"title":"Products.MigrateVariantRequestModel"},"ProductsVariantViewModelChannelMetadataItems":{"oneOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.AmazonChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataViewModel"}],"title":"ProductsVariantViewModelChannelMetadataItems"},"Products.VariantViewModel":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel","description":"Additional hazardous materials attributes for lithium batteries and dangerous goods"},"associated_bundles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"description":"List of bundle products that include this variant as a component"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"description":"If this variant is a bundle, defines which variants and quantities make up the bundle"},"created_on":{"type":"string","format":"date-time","description":"Timestamp when the variant was created"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModel","description":"Customs and international shipping information (tariff codes, country of origin, declared value)"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel","description":"Physical dimensions of the variant (length, width, height)"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel","description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)"},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - standardized product identifier"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel","description":"Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels."},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)"},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel","description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements"},"merge_children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"description":"List of variants that have been merged into this variant"},"name":{"type":["string","null"],"description":"Variant name or descriptor"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Type of packaging material used for this variant (ID and name)"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Special packaging requirements for this variant (ID and name)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel","description":"Customer return handling preferences including primary and backup actions"},"reviews_pending":{"type":["array","null"],"items":{"type":"string"},"description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)"},"sku":{"type":["string","null"],"description":"Stock Keeping Unit - unique identifier for the variant used in inventory management"},"status":{"type":["string","null"],"description":"Current status of the variant (e.g., 'Active', 'Inactive')"},"upc":{"type":["string","null"],"description":"Universal Product Code - 12-digit barcode identifier"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the variant was last updated"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel","description":"Weight of the variant including unit of measure"},"barcode":{"type":["string","null"]},"barcode_sticker_url":{"type":["string","null"]},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsVariantViewModelChannelMetadataItems"}}},"title":"Products.VariantViewModel"},"Products.VariantInternalViewModel":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel","description":"Additional hazardous materials attributes for lithium batteries and dangerous goods"},"associated_bundles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"description":"List of bundle products that include this variant as a component"},"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"description":"If this variant is a bundle, defines which variants and quantities make up the bundle"},"created_on":{"type":"string","format":"date-time","description":"Timestamp when the variant was created"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModel","description":"Customs and international shipping information (tariff codes, country of origin, declared value)"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel","description":"Physical dimensions of the variant (length, width, height)"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel","description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)"},"gtin":{"type":["string","null"],"description":"Global Trade Item Number - standardized product identifier"},"id":{"type":"integer","format":"int64","description":"Unique identifier for the variant"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel","description":"Current inventory information including on-hand quantity. This is not the source of truth for inventory levels. Use the latest Inventory API for current inventory levels."},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)"},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel","description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements"},"merge_children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"description":"List of variants that have been merged into this variant"},"name":{"type":["string","null"],"description":"Variant name or descriptor"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Type of packaging material used for this variant (ID and name)"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel","description":"Special packaging requirements for this variant (ID and name)"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel","description":"Customer return handling preferences including primary and backup actions"},"reviews_pending":{"type":["array","null"],"items":{"type":"string"},"description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)"},"sku":{"type":["string","null"],"description":"Stock Keeping Unit - unique identifier for the variant used in inventory management"},"status":{"type":["string","null"],"description":"Current status of the variant (e.g., 'Active', 'Inactive')"},"upc":{"type":["string","null"],"description":"Universal Product Code - 12-digit barcode identifier"},"updated_on":{"type":["string","null"],"format":"date-time","description":"Timestamp when the variant was last updated"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel","description":"Weight of the variant including unit of measure"},"barcode":{"type":["string","null"]},"barcode_sticker_url":{"type":["string","null"]},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsVariantViewModelChannelMetadataItems"}},"compliance":{"$ref":"#/components/schemas/Products.ComplianceViewModel"}},"title":"Products.VariantInternalViewModel"},"ProductsProductViewModelVariantsItems":{"oneOf":[{"$ref":"#/components/schemas/Products.VariantViewModel"},{"$ref":"#/components/schemas/Products.VariantInternalViewModel"}],"title":"ProductsProductViewModelVariantsItems"},"Products.ProductViewModel":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/Products.EnumViewModel"},"created_on":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"name":{"type":["string","null"]},"sub_category":{"$ref":"#/components/schemas/Products.EnumViewModel"},"taxonomy":{"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel"},"type":{"type":["string","null"]},"updated_on":{"type":["string","null"],"format":"date-time"},"user_id":{"type":"integer","format":"int64"},"variants":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsProductViewModelVariantsItems"}}},"title":"Products.ProductViewModel"},"Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object"},"Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object"},"Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.ApplicableCategoryViewModel":{"type":"object","properties":{"id":{"type":"integer"},"sub_category_ids":{"type":["array","null"],"items":{"type":"integer"}}},"title":"Products.ApplicableCategoryViewModel"},"Products.PackagingMaterialTypeViewModel":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":["string","null"]}},"title":"Products.PackagingMaterialTypeViewModel"},"Products.PackagingRequirementViewModel":{"type":"object","properties":{"applicable_categories":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.ApplicableCategoryViewModel"},"description":"List of product categories where this packaging requirement is applicable"},"applicable_packaging_material_types":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.PackagingMaterialTypeViewModel"},"description":"List of packaging material types that are compatible with this requirement"},"applicable_taxonomy":{"type":["array","null"],"items":{"type":"string"},"description":"List of taxonomy paths where this packaging requirement can be applied"},"description":{"type":["string","null"],"description":"Detailed explanation of the packaging requirement and when it should be used"},"id":{"type":"integer","description":"Unique identifier for the packaging requirement"},"name":{"type":["string","null"],"description":"Display name of the packaging requirement (e.g., 'Poly Bag', 'Bubble Wrap')"}},"title":"Products.PackagingRequirementViewModel"},"Products.PackagingRequirementViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.PackagingRequirementViewModel"},"title":"Products.PackagingRequirementViewModelArray"},"Products.Get.Api.V5.Taxonomy.Search.String":{"type":"string","title":"Products.Get.Api.V5.Taxonomy.Search.String"},"Products.ChildTaxonomyViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the taxonomy node"},"name":{"type":["string","null"],"description":"Display name of the taxonomy category"},"path":{"type":["string","null"],"description":"Full hierarchical path of the taxonomy (e.g., 'Electronics > Computers > Laptops')"},"has_children":{"type":"boolean"}},"title":"Products.ChildTaxonomyViewModel"},"Products.BaseTaxonomyViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the taxonomy node"},"name":{"type":["string","null"],"description":"Display name of the taxonomy category"},"path":{"type":["string","null"],"description":"Full hierarchical path of the taxonomy (e.g., 'Electronics > Computers > Laptops')"}},"title":"Products.BaseTaxonomyViewModel"},"ProductsTaxonomyViewModelParent":{"oneOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"},{"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}],"description":"Parent taxonomy node in the category hierarchy","title":"ProductsTaxonomyViewModelParent"},"Products.TaxonomyViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the taxonomy node"},"name":{"type":["string","null"],"description":"Display name of the taxonomy category"},"path":{"type":["string","null"],"description":"Full hierarchical path of the taxonomy (e.g., 'Electronics > Computers > Laptops')"},"children":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},"description":"Child taxonomy nodes that belong to this category"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ProductsTaxonomyViewModelParent"},{"type":"null"}],"description":"Parent taxonomy node in the category hierarchy"}},"title":"Products.TaxonomyViewModel"},"Products.TaxonomyViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"},"title":"Products.TaxonomyViewModelArray"},"Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Id.Id.Integer":{"type":"integer","title":"Products.Get.Api.V5.Taxonomy.Id.Id.Integer"},"Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Id.Parent.Id.Integer":{"type":"integer","title":"Products.Get.Api.V5.Taxonomy.Id.Parent.Id.Integer"},"Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Delete.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","title":"Products.Delete.Api.V5.Product.ProductId.ProductId.Integer"},"Products_deleteProductBundle_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Products_deleteProductBundle_Response_200"},"Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object"},"Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}],"title":"Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"Products.Post.Api.V5.Variant.VariantId.ConvertToBundle.VariantId.Integer":{"type":"integer","format":"int64","title":"Products.Post.Api.V5.Variant.VariantId.ConvertToBundle.VariantId.Integer"},"Products.AmazonChannelMetadataRequestModel":{"type":"object","properties":{"channel_id":{"type":["integer","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]},"asin":{"type":["string","null"]},"fnsku":{"type":["string","null"]},"fulfillment_channel":{"type":["string","null"]}},"description":"Amazon Sales Channel Information with custom Amazon Fields","title":"Products.AmazonChannelMetadataRequestModel"},"Products.BigCommerceChannelMetadataRequestModel":{"type":"object","properties":{"channel_id":{"type":["integer","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]},"platform_product_id":{"type":["integer","null"],"format":"int64"},"platform_variant_id":{"type":["integer","null"],"format":"int64"}},"description":"BigCommerce Sales Channel Information with custom Amazon Fields","title":"Products.BigCommerceChannelMetadataRequestModel"},"Products.ShopifyChannelMetadataRequestModel":{"type":"object","properties":{"channel_id":{"type":["integer","null"]},"currency":{"type":["string","null"]},"id":{"type":["integer","null"],"format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":["integer","null"],"format":"int64"},"platform":{"type":["string","null"]},"platform_identifier":{"type":["string","null"]},"platform_inventory_item_id":{"type":["string","null"]},"price":{"type":"number","format":"double"},"seller_sku":{"type":["string","null"]}},"description":"Shopify Sales Channel Information","title":"Products.ShopifyChannelMetadataRequestModel"},"ProductsConvertVariantToBundleRequestChannelMetadataItems":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}],"title":"ProductsConvertVariantToBundleRequestChannelMetadataItems"},"Products.ConvertVariantToBundleRequest":{"type":"object","properties":{"bundle_definition":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"}},"channel_metadata":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ProductsConvertVariantToBundleRequestChannelMetadataItems"}},"name":{"type":["string","null"]},"sku":{"type":["string","null"]}},"title":"Products.ConvertVariantToBundleRequest"},"Products.AllergenViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the allergen"},"key":{"type":["string","null"],"description":"Stable machine-readable key for the allergen"},"name":{"type":["string","null"],"description":"Human-readable name of the allergen"}},"title":"Products.AllergenViewModel"},"Products.AllergenViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.AllergenViewModel"},"title":"Products.AllergenViewModelArray"},"Inventory.Get.Api.V4.Inventory.Levels.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).","title":"Inventory.Get.Api.V4.Inventory.Levels.SearchBy.String"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer"},"description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.","title":"Inventory.Get.Api.V4.Inventory.Levels.InventoryIds.IntegerArray"},"Inventory.Get.Api.V4.Inventory.Levels.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.","title":"Inventory.Get.Api.V4.Inventory.Levels.IsActive.Boolean"},"Inventory.Get.Api.V4.Inventory.Levels.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.","title":"Inventory.Get.Api.V4.Inventory.Levels.IsDigital.Boolean"},"Inventory.Get.Api.V4.Inventory.Levels.PageSize.Integer":{"type":"integer","description":"Number of inventory level items to return per page. Controls pagination size for the response.","title":"Inventory.Get.Api.V4.Inventory.Levels.PageSize.Integer"},"Inventory.Get.Api.V4.Inventory.Levels.SortBy.String":{"type":"string","description":"Sort results by field name. Valid fields: id, inventory_id, name, sku, total_fulfillable_quantity, total_on_hand_quantity, total_committed_quantity, total_sellable_quantity, total_awaiting_quantity, total_exception_quantity, total_internal_transfer_quantity, total_backordered_quantity, total_in_fulfillment_quantity, total_quarantine_quantity. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'total_on_hand_quantity desc' sorts by quantity descending).","title":"Inventory.Get.Api.V4.Inventory.Levels.SortBy.String"},"Inventory.InventoryQuantityV4Response":{"type":"object","properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item"},"name":{"type":["string","null"],"description":"Name of the inventory item"},"sku":{"type":["string","null"],"description":"Stock keeping unit identifier"},"total_awaiting_quantity":{"type":"integer","description":"Total quantity expected to arrive from receiving or transfers"},"total_backordered_quantity":{"type":"integer","description":"Total quantity on backorder for pending shipments"},"total_committed_quantity":{"type":"integer","description":"Total quantity reserved for existing orders and allocations"},"total_damaged_quantity":{"type":"integer","description":"Total quantity currently marked as damaged"},"total_exception_quantity":{"type":"integer","description":"Total quantity in exception status (damaged, lost, or under investigation)"},"total_fulfillable_quantity":{"type":"integer","description":"Total quantity available to fulfill new orders (on-hand minus committed)"},"total_in_fulfillment_quantity":{"type":"integer","description":"Total quantity of inventory items that are currently in the fulfillment process"},"total_internal_transfer_quantity":{"type":"integer","description":"Total quantity currently in transit between fulfillment centers"},"total_on_hand_quantity":{"type":"integer","description":"Total quantity physically present in all fulfillment centers"},"total_quarantine_quantity":{"type":"integer","description":"Total quantity currently in quarantine status"},"total_sellable_quantity":{"type":"integer","description":"Total quantity available for sale (fulfillable plus awaiting minus quarantine minus damaged)"}},"title":"Inventory.InventoryQuantityV4Response"},"Inventory.InventoryQuantityV4ResponsePagedResponse":{"type":"object","properties":{"first":{"type":["string","null"],"description":"URL to retrieve the first page of results. Null if already on the first page."},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityV4Response"},"description":"Array of inventory quantity items in the current page of results."},"last":{"type":["string","null"],"description":"URL to retrieve the last page of results. Null if already on the last page."},"next":{"type":["string","null"],"description":"URL to retrieve the next page of results. Null if on the last page."},"prev":{"type":["string","null"],"description":"URL to retrieve the previous page of results. Null if on the first page."}},"title":"Inventory.InventoryQuantityV4ResponsePagedResponse"},"Inventory.ProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"],"description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":["string","null"],"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."},"status":{"type":["integer","null"],"description":"The HTTP status code for this occurrence of the problem."},"title":{"type":["string","null"],"description":"A short, human-readable summary of the problem type."},"type":{"type":["string","null"],"description":"A URI reference that identifies the problem type. This URI should provide human-readable documentation for the problem."}},"title":"Inventory.ProblemDetails"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.InventoryId.Integer"},"Inventory.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve. This ID is returned when listing all inventories and is used to fetch detailed information about a specific inventory item.","title":"Inventory.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer"},"Inventory.DimensionsResponse":{"type":"object","properties":{"height":{"type":"number","format":"double","description":"Height measurement of the inventory item"},"is_locked":{"type":"boolean","description":"Indicates whether dimensions are locked and cannot be modified"},"length":{"type":"number","format":"double","description":"Length measurement of the inventory item"},"unit":{"type":["string","null"],"description":"Unit of measurement for dimensions (i.e. inches)"},"validated":{"type":"boolean","description":"Indicates whether dimensions have been validated by warehouse staff"},"width":{"type":"number","format":"double","description":"Width measurement of the inventory item"}},"title":"Inventory.DimensionsResponse"},"Inventory.HazmatResponse":{"type":"object","properties":{"is_hazmat":{"type":"boolean","description":"Indicates if the inventory item is classified as hazardous material"},"validated":{"type":"boolean","description":"Indicates whether hazmat status has been validated and confirmed"}},"title":"Inventory.HazmatResponse"},"Inventory.VariantResponse":{"type":"object","properties":{"hazmat":{"$ref":"#/components/schemas/Inventory.HazmatResponse","description":"Hazardous materials information"},"is_active":{"type":"boolean","description":"Indicates if the variant is currently active and available for fulfillment"},"is_bundle":{"type":"boolean","description":"Indicates if this item is a bundle of multiple products"},"is_digital":{"type":"boolean","description":"Indicates if this is a digital product (no physical fulfillment required)"}},"title":"Inventory.VariantResponse"},"Inventory.WeightResponse":{"type":"object","properties":{"unit":{"type":["string","null"],"description":"Unit of measurement for weight (e.g., pounds, kilograms)"},"value":{"type":"number","format":"double","description":"Weight value of the inventory item"}},"title":"Inventory.WeightResponse"},"Inventory.InventoryResponse":{"type":"object","properties":{"barcode":{"type":["string","null"],"description":"Barcode associated with the inventory item"},"dimensions":{"$ref":"#/components/schemas/Inventory.DimensionsResponse","description":"Physical dimensions of the inventory item"},"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item"},"is_case":{"type":"boolean","description":"Indicates if the inventory item is stored in cases"},"is_lot":{"type":"boolean","description":"Indicates if the inventory item is tracked by lot number"},"name":{"type":["string","null"],"description":"Name of the inventory item"},"sku":{"type":["string","null"],"description":"Stock keeping unit identifier"},"user_id":{"type":"integer","description":"User ID associated with this inventory item"},"variant":{"$ref":"#/components/schemas/Inventory.VariantResponse","description":"Variant details including active status and product characteristics"},"weight":{"$ref":"#/components/schemas/Inventory.WeightResponse","description":"Weight information of the inventory item"}},"title":"Inventory.InventoryResponse"},"Inventory.Get.Api.V3.Inventories.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).","title":"Inventory.Get.Api.V3.Inventories.SearchBy.String"},"Inventory.FilterOperation":{"type":"object","properties":{"key":{"type":["string","null"],"description":"Filter field name to apply the operation to (e.g., 'sku', 'name', 'is_active')"},"rawValue":{"type":["string","null"],"description":"Filter value to match against the specified field"}},"title":"Inventory.FilterOperation"},"Inventory.FilterOperationArray":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.FilterOperation"},"description":"Advanced filtering operations. Apply multiple key-value filters to refine inventory results. Each filter operation contains a 'key' (field name) and 'rawValue' (filter value) to match.","title":"Inventory.FilterOperationArray"},"Inventory.Get.Api.V3.Inventories.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer"},"description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve information for specific inventory items only. To find an item by SKU or name, use SearchBy instead.","title":"Inventory.Get.Api.V3.Inventories.InventoryIds.IntegerArray"},"Inventory.Get.Api.V3.Inventories.IsActive.Boolean":{"type":"boolean","description":"Filter by active status. True returns only active inventory items, False returns only inactive items. Omit to return both.","title":"Inventory.Get.Api.V3.Inventories.IsActive.Boolean"},"Inventory.Get.Api.V3.Inventories.IsDigital.Boolean":{"type":"boolean","description":"Filter by digital product status. True returns only digital products (no physical fulfillment), False returns only physical products. Omit to return both.","title":"Inventory.Get.Api.V3.Inventories.IsDigital.Boolean"},"Inventory.Get.Api.V3.Inventories.PageSize.Integer":{"type":"integer","description":"Number of items to return per page. Controls pagination size for the response.","title":"Inventory.Get.Api.V3.Inventories.PageSize.Integer"},"Inventory.Get.Api.V3.Inventories.SortBy.String":{"type":"string","description":"Sort results by field name. Valid fields: id, inventory_id, name, barcode, sku. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'name desc' sorts by name descending).","title":"Inventory.Get.Api.V3.Inventories.SortBy.String"},"Inventory.InventoryResponsePagedResponse":{"type":"object","properties":{"first":{"type":["string","null"],"description":"URL to retrieve the first page of results. Null if already on the first page."},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.InventoryResponse"},"description":"Array of inventory items in the current page of results."},"last":{"type":["string","null"],"description":"URL to retrieve the last page of results. Null if already on the last page."},"next":{"type":["string","null"],"description":"URL to retrieve the next page of results. Null if on the last page."},"prev":{"type":["string","null"],"description":"URL to retrieve the previous page of results. Null if on the first page."}},"title":"Inventory.InventoryResponsePagedResponse"},"FulfillmentCenterInventoryService.Post.Inventory.History.Query.Cursor.Integer":{"type":"integer","title":"FulfillmentCenterInventoryService.Post.Inventory.History.Query.Cursor.Integer"},"FulfillmentCenterInventoryService.MerchantHistoryRequest":{"type":"object","properties":{"cursor":{"type":["integer","null"],"description":"Optional. Pagination cursor using the `inventory_audit_event_id` from the previous response. Returns events after this ID."},"end_date":{"type":["string","null"],"format":"date-time","description":"Optional. End date for filtering events. If omitted, defaults to current date."},"event_category":{"type":["string","null"],"description":"Optional. Filter by event type: `OrderPicked`, `InventoryAdjusted`, `InventoryFacilityUpdated`, `AttributeUpdated`, `InventoryReceived`, `InventoryRestocked`, `ReceivingStow`, or `KittingStow`."},"facility_id":{"type":"integer","description":"Required. The ShipBob fulfillment center ID where the inventory events occurred."},"inventory_ids":{"type":["array","null"],"items":{"type":"integer"},"description":"Optional. Filter by specific inventory IDs. Returns events for these inventories only."},"merchant_user_id":{"type":["integer","null"],"description":"Optional. Filter by merchant user ID. Returns events associated with this user."},"start_date":{"type":["string","null"],"format":"date-time","description":"Optional. Start date for filtering events. If omitted, defaults to 90 days ago. Maximum range is 90 days."}},"title":"FulfillmentCenterInventoryService.MerchantHistoryRequest"},"FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference":{"type":"object","properties":{"key":{"type":["string","null"],"description":"The reference key (e.g., WRO ID, order ID, or other contextual identifier)."},"value":{"type":["string","null"],"description":"The reference value corresponding to the key."}},"title":"FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference"},"FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse":{"type":"object","properties":{"description":{"type":["string","null"],"description":"Human-readable description of the operational stage (e.g., 'Available', 'Reserved', 'In Transit')."},"id":{"type":"integer","description":"Numeric identifier for the operational stage."}},"title":"FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse"},"FulfillmentCenterInventoryService.Ulid":{"type":"object","properties":{"random":{"type":["string","null"],"format":"byte","description":"Random component of the ULID (Universally Unique Lexicographically Sortable Identifier)."},"time":{"type":"string","format":"date-time","description":"Timestamp component of the ULID, representing when the identifier was created."}},"title":"FulfillmentCenterInventoryService.Ulid"},"FulfillmentCenterInventoryService.InventoryHistoryDetails":{"type":"object","properties":{"committed_quantity_change":{"type":"integer","description":"The change in committed (allocated) quantity."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The expiration date for this inventory lot, if applicable."},"facility_id":{"type":"integer","description":"The fulfillment center ID where this quantity change occurred."},"inventory_status":{"type":["string","null"],"description":"The current status of the inventory."},"location_id":{"type":"integer","description":"The physical shelf/bin location ID within the fulfillment center."},"lot_number":{"type":["string","null"],"description":"The lot number associated with this inventory, if applicable."},"operational_stage":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse","description":"The operational stage of the inventory (e.g., available, reserved, in-transit)."},"pack_description_id":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid","description":"Identifier for the packaging configuration of this inventory."},"quantity_change":{"type":"integer","description":"The change in on-hand quantity. Positive for increments, negative for decrements."},"sku":{"type":["string","null"],"description":"The merchant SKU for this inventory item."},"yuki_id":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid","description":"Unique identifier for the physical inventory unit (Yuki) in ShipBob's system."}},"title":"FulfillmentCenterInventoryService.InventoryHistoryDetails"},"FulfillmentCenterInventoryService.InventoryHistory":{"type":"object","properties":{"additional_reference":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference"},"description":"Additional key-value reference data related to this event."},"decrement":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails","description":"Details of the source location where inventory quantity decreased."},"event_category":{"type":["string","null"],"description":"The type of inventory event. Supported values: `OrderPicked`, `InventoryAdjusted`, `InventoryFacilityUpdated`, `AttributeUpdated`, `InventoryReceived`, `InventoryRestocked`, `ReceivingStow`, `KittingStow`."},"event_datetime":{"type":"string","format":"date-time","description":"The timestamp when this inventory event occurred."},"increment":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails","description":"Details of the destination location where inventory quantity increased."},"inventory_audit_event_id":{"type":"integer","description":"Unique identifier for this event. Use as cursor value for pagination to fetch subsequent records."},"inventory_id":{"type":"integer","description":"The ShipBob inventory ID for this item."},"merchant_user_id":{"type":["integer","null"],"description":"The merchant user ID associated with this inventory."},"shipbob_order_id":{"type":["integer","null"],"description":"The ShipBob order ID associated with this event, if applicable (e.g., for `OrderPicked` events)."}},"title":"FulfillmentCenterInventoryService.InventoryHistory"},"FulfillmentCenterInventoryService.InventoryHistoryResponse":{"type":"object","properties":{"data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistory"},"description":"Array of inventory history events matching the query criteria."},"first":{"type":["string","null"],"description":"URL to retrieve the first page of results."},"last":{"type":["string","null"],"description":"URL to retrieve the last page of results."},"next":{"type":["string","null"],"description":"URL to retrieve the next page of results. Null if no more results available."},"prev":{"type":["string","null"],"description":"URL to retrieve the previous page of results. Null if on the first page."}},"title":"FulfillmentCenterInventoryService.InventoryHistoryResponse"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationType.String":{"type":"string","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationType.String"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationId.Integer"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.SearchBy.String":{"type":"string","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.SearchBy.String"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer"},"title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.InventoryIds.IntegerArray"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.IsActive.Boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.IsDigital.Boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.PageSize.Integer"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.SortBy.String":{"type":"string","description":"Sort results by field name. Valid fields: id, inventory_id, name, sku, fulfillable_quantity, on_hand_quantity, committed_quantity, awaiting_quantity, internal_transfer_quantity, in_fulfillment_quantity, exception_quantity, quarantine_quantity. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'on_hand_quantity desc' sorts by on-hand quantity descending).","title":"Inventory.Get.Api.V4.Inventory.Levels.Locations.SortBy.String"},"Inventory.FulfillmentCenterV4Response":{"type":"object","properties":{"awaiting_quantity":{"type":"integer"},"committed_quantity":{"type":"integer"},"damaged_quantity":{"type":"integer"},"exception_quantity":{"type":"integer"},"fulfillable_quantity":{"type":"integer"},"in_fulfillment_quantity":{"type":"integer"},"internal_transfer_quantity":{"type":"integer"},"location_id":{"type":"integer"},"name":{"type":["string","null"]},"on_hand_quantity":{"type":"integer"},"quarantine_quantity":{"type":"integer"}},"title":"Inventory.FulfillmentCenterV4Response"},"Inventory.InventoryQuantityFcV4Response":{"type":"object","properties":{"inventory_id":{"type":"integer"},"locations":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.FulfillmentCenterV4Response"}},"name":{"type":["string","null"]},"sku":{"type":["string","null"]}},"title":"Inventory.InventoryQuantityFcV4Response"},"Inventory.InventoryQuantityFcV4ResponsePagedResponse":{"type":"object","properties":{"first":{"type":["string","null"]},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcV4Response"}},"last":{"type":["string","null"]},"next":{"type":["string","null"]},"prev":{"type":["string","null"]}},"title":"Inventory.InventoryQuantityFcV4ResponsePagedResponse"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Locations.InventoryId.Integer"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.LocationId.Integer"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.SearchBy.String":{"type":"string","title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.SearchBy.String"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer"},"title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.InventoryIds.IntegerArray"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean","title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.IsActive.Boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean","title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.IsDigital.Boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.PageSize.Integer"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.SortBy.String":{"type":"string","description":"Sort results by field name. Valid fields: id, inventory_id, name, sku, fulfillable_quantity, on_hand_quantity, committed_quantity, awaiting_quantity, internal_transfer_quantity, in_fulfillment_quantity, exception_quantity, quarantine_quantity. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'on_hand_quantity desc' sorts by on-hand quantity descending).","title":"Inventory.Get.Api.V4.Inventory.Levels.Lots.SortBy.String"},"Inventory.FulfillableQuantityByFulfillmentCenterV4":{"type":"object","properties":{"awaiting_quantity":{"type":"integer"},"committed_quantity":{"type":"integer"},"damaged_quantity":{"type":"integer"},"exception_quantity":{"type":"integer"},"fulfillable_quantity":{"type":"integer"},"in_fulfillment_quantity":{"type":"integer"},"internal_transfer_quantity":{"type":"integer"},"location_id":{"type":"integer"},"name":{"type":["string","null"]},"on_hand_quantity":{"type":"integer"},"quarantine_quantity":{"type":"integer"}},"title":"Inventory.FulfillableQuantityByFulfillmentCenterV4"},"Inventory.LotsV4":{"type":"object","properties":{"awaiting_quantity":{"type":"integer"},"committed_quantity":{"type":"integer"},"damaged_quantity":{"type":"integer"},"exception_quantity":{"type":"integer"},"fulfillable_quantity":{"type":"integer"},"in_fulfillment_quantity":{"type":"integer"},"internal_transfer_quantity":{"type":"integer"},"locations":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.FulfillableQuantityByFulfillmentCenterV4"}},"lot_date":{"type":["string","null"],"format":"date-time"},"lot_number":{"type":["string","null"]},"on_hand_quantity":{"type":"integer"},"quarantine_quantity":{"type":"integer"}},"title":"Inventory.LotsV4"},"Inventory.InventoryQuantityLotV4Response":{"type":"object","properties":{"inventory_id":{"type":"integer"},"lots":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.LotsV4"}},"name":{"type":["string","null"]},"sku":{"type":["string","null"]}},"title":"Inventory.InventoryQuantityLotV4Response"},"Inventory.InventoryQuantityLotV4ResponsePagedResponse":{"type":"object","properties":{"first":{"type":["string","null"]},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotV4Response"}},"last":{"type":["string","null"]},"next":{"type":["string","null"]},"prev":{"type":["string","null"]}},"title":"Inventory.InventoryQuantityLotV4ResponsePagedResponse"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","title":"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Lots.InventoryId.Integer"},"Inventory.Get.Api.V4.Lot.Exclusions.Sku.String":{"type":"string","description":"SKU of the inventory item to retrieve lot exclusions for.","title":"Inventory.Get.Api.V4.Lot.Exclusions.Sku.String"},"Inventory.Get.Api.V4.Lot.Exclusions.InventoryId.Integer":{"type":"integer","description":"Unique identifier of the inventory item to retrieve lot exclusions for.","title":"Inventory.Get.Api.V4.Lot.Exclusions.InventoryId.Integer"},"InventoryLotExclusionsResponseLotExclusionsItems":{"type":"object","properties":{"created_timestamp":{"type":"string","format":"date-time","description":"Timestamp when the lot exclusion was created"},"deleted_timestamp":{"type":["string","null"],"format":"date-time","description":"Timestamp when the lot exclusion was deleted, null if active"},"id":{"type":"integer","description":"Unique identifier of the lot exclusion"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion has been soft-deleted"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the excluded lot"},"lot_number":{"type":"string","description":"The lot number excluded from fulfillment"}},"title":"InventoryLotExclusionsResponseLotExclusionsItems"},"Inventory.LotExclusionsResponse":{"type":"object","properties":{"inventory_name":{"type":"string","description":"Name of the inventory item"},"inventory_sku":{"type":"string","description":"SKU of the inventory item"},"lot_exclusions":{"type":"array","items":{"$ref":"#/components/schemas/InventoryLotExclusionsResponseLotExclusionsItems"},"description":"List of lot exclusions for the inventory item"}},"title":"Inventory.LotExclusionsResponse"},"Inventory.Post.Api.V4.Lot.Exclusions.CreateLotExclusionRequest":{"type":"object","properties":{"inventory_id":{"type":["integer","null"],"description":"Unique identifier of the inventory item, either this or sku must be provided"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the lot"},"lot_number":{"type":"string","description":"The lot number to exclude from fulfillment"},"sku":{"type":["string","null"],"description":"SKU of the inventory item, either this or inventory_id must be provided"}},"required":["lot_number"],"title":"Inventory.Post.Api.V4.Lot.Exclusions.CreateLotExclusionRequest"},"Inventory.CreateLotExclusionResponse":{"type":"object","properties":{"created_timestamp":{"type":"string","format":"date-time","description":"Timestamp when the lot exclusion was created"},"deleted_timestamp":{"type":["string","null"],"format":"date-time","description":"Timestamp when the lot exclusion was deleted, null if active"},"id":{"type":"integer","description":"Unique identifier of the created lot exclusion"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion has been soft-deleted"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the excluded lot"},"lot_number":{"type":"string","description":"The lot number excluded from fulfillment"}},"title":"Inventory.CreateLotExclusionResponse"},"Inventory.Post.Api.V4.Lot.Exclusions.Restore.RestoreLotExclusionRequest":{"type":"object","properties":{"inventory_id":{"type":["integer","null"],"description":"Unique identifier of the inventory item, either this or sku must be provided"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the lot"},"lot_number":{"type":"string","description":"The lot number of the exclusion to restore"},"sku":{"type":["string","null"],"description":"SKU of the inventory item, either this or inventory_id must be provided"}},"required":["lot_number"],"title":"Inventory.Post.Api.V4.Lot.Exclusions.Restore.RestoreLotExclusionRequest"},"Inventory.RestoreLotExclusionResponse":{"type":"object","properties":{"deleted_timestamp":{"type":["string","null"],"format":"date-time","description":"Timestamp when the lot exclusion was deleted, null after restore"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion is still deleted, false after restore"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the lot"},"lot_number":{"type":"string","description":"The lot number of the restored exclusion"}},"title":"Inventory.RestoreLotExclusionResponse"},"Inventory.Post.Api.V4.Lot.Exclusions.Delete.DeleteLotExclusionRequest":{"type":"object","properties":{"inventory_id":{"type":["integer","null"],"description":"Unique identifier of the inventory item, either this or sku must be provided"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the lot"},"lot_number":{"type":"string","description":"The lot number of the exclusion to delete"},"sku":{"type":["string","null"],"description":"SKU of the inventory item, either this or inventory_id must be provided"}},"required":["lot_number"],"title":"Inventory.Post.Api.V4.Lot.Exclusions.Delete.DeleteLotExclusionRequest"},"Inventory.DeleteLotExclusionResponse":{"type":"object","properties":{"deleted_timestamp":{"type":["string","null"],"format":"date-time","description":"Timestamp when the lot exclusion was deleted"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion has been soft-deleted"},"lot_date":{"type":["string","null"],"format":"date-time","description":"The date associated with the lot"},"lot_number":{"type":"string","description":"The lot number of the deleted exclusion"}},"title":"Inventory.DeleteLotExclusionResponse"},"Receiving.PackingType":{"type":"string","enum":["EverythingInOneBox","OneSkuPerBox","MultipleSkuPerBox"],"title":"Receiving.PackingType"},"Receiving.V3.AddBoxItemToBoxV3Model":{"type":"object","properties":{"inventory_id":{"type":["integer","null"],"description":"Unique inventory id of the items in the box (optional if sku is provided)"},"lot_date":{"type":["string","null"],"format":"date-time","description":"Lot expiration date for the items in the box. Optional; may be null or omitted. When provided, requires a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z; a bare date such as 2026-08-05 is rejected."},"lot_number":{"type":["string","null"],"description":"Lot number of the items in the box"},"quantity":{"type":"integer","minimum":1,"maximum":2147483647,"description":"Quantity of the items in the box"},"sku":{"type":["string","null"],"description":"SKU identifier for the items in the box (optional if inventory_id is provided)"}},"required":["quantity"],"description":"Information about an inventory item contained inside a receiving order box.\r\nAt least one of inventory_id or sku must be provided.","title":"Receiving.V3.AddBoxItemToBoxV3Model"},"Receiving.V3.AddBoxToOrderV3Model":{"type":"object","properties":{"box_items":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V3.AddBoxItemToBoxV3Model"},"description":"Items contained in this box. A receiving order may reference at most 10,000 unique inventory items (SKUs) across all of its boxes; exceeding this returns a 422 with the WRO_UNIQUE_SKU_LIMIT_EXCEEDED reason code. The limit applies to distinct inventory_ids across the whole order, not to a single box."},"tracking_number":{"type":"string","minLength":1,"description":"Tracking number for the box shipment"}},"required":["box_items","tracking_number"],"description":"Information about a box shipment to be added to a V3 receiving order","title":"Receiving.V3.AddBoxToOrderV3Model"},"Receiving.AssignOrderToFulfillmentCenterModel":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the fulfillment center to assign this receiving order to"}},"required":["id"],"description":"Model containing information that assigns a receiving order to a fulfillment center.\r\nIf the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location.","title":"Receiving.AssignOrderToFulfillmentCenterModel"},"Receiving.PackageType":{"type":"string","enum":["Package","Pallet","FloorLoadedContainer"],"title":"Receiving.PackageType"},"Receiving.V3.CreateReceivingOrderV3Model":{"type":"object","properties":{"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"boxes":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V3.AddBoxToOrderV3Model"},"description":"Box shipments to be added to this receiving order"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Expected arrival date of all the box shipments in this receiving order. Requires a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z; a bare date such as 2026-08-05 is rejected."},"final_destination_fulfillment_center_id":{"type":["integer","null"],"minimum":1,"description":"Fulfillment center the inventory is routed to after it is received at fulfillment_center, such as a spoke site served by a receiving hub. Only allowed for certain fulfillment centers and merchants. Fees may apply when routing to it requires cross-region transportation."},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.AssignOrderToFulfillmentCenterModel"},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":["string","null"],"description":"Purchase order number for this receiving order"}},"required":["box_packaging_type","boxes","expected_arrival_date","fulfillment_center","package_type"],"description":"Information to create a new receiving order","title":"Receiving.V3.CreateReceivingOrderV3Model"},"Receiving.FulfillmentCenterViewModel":{"type":"object","properties":{"address1":{"type":["string","null"],"description":"Address line one of the fulfillment center"},"address2":{"type":["string","null"],"description":"Address line two of the fulfillment center"},"city":{"type":["string","null"],"description":"City the fulfillment center is located in"},"country":{"type":["string","null"],"description":"Country the fulfillment center is located in"},"email":{"type":["string","null"],"description":"Email contact for the fulfillment center"},"id":{"type":"integer","description":"Unique identifier of the fulfillment center"},"name":{"type":["string","null"],"description":"Name of the fulfillment center"},"phone_number":{"type":["string","null"],"description":"Phone number contact for the fulfillment center"},"state":{"type":["string","null"],"description":"State the fulfillment center is located in"},"timezone":{"type":["string","null"],"description":"Timezone the fulfillment center is located in"},"zip_code":{"type":["string","null"],"description":"Postal code of the fulfillment center"}},"description":"Information about a fulfillment center","title":"Receiving.FulfillmentCenterViewModel"},"Receiving.V2.InventoryQuantityViewModel":{"type":"object","properties":{"expected_quantity":{"type":"integer","description":"Quantity of the inventory item submitted in the WRO"},"inventory_id":{"type":"integer","description":"ID of the inventory item"},"received_quantity":{"type":"integer","description":"Quantity of the inventory item received by the warehouse"},"sku":{"type":["string","null"],"description":"Sku of the inventory item"},"stowed_quantity":{"type":"integer","description":"Quantity of the inventory item stowed by the warehouse"}},"title":"Receiving.V2.InventoryQuantityViewModel"},"Receiving.ReceivingStatus":{"type":"string","enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"],"title":"Receiving.ReceivingStatus"},"Receiving.V2.ReceivingOrderStatusHistoryViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the status"},"status":{"type":["string","null"],"description":"Name of the status"},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the status was recorded"}},"description":"View model for receiving order status history","title":"Receiving.V2.ReceivingOrderStatusHistoryViewModel"},"Receiving.V3.WarehouseReceivingOrderViewModel":{"type":"object","properties":{"box_labels_uri":{"type":["string","null"],"description":"URL to the packing slip to be included in each box shipment for this receiving order"},"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Expected date that all packages will have arrived. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"external_sync_timestamp":{"type":["string","null"],"format":"date-time","description":"The timestamp in UTC when a 3rd party integrator has set in our system"},"final_destination_fulfillment_center_id":{"type":["integer","null"],"description":"Fulfillment center the inventory is routed to after it is received at fulfillment_center, when one was set on the receiving order. Null otherwise."},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"},"id":{"type":"integer","description":"Unique id of the warehouse receiving order"},"insert_date":{"type":"string","format":"date-time","description":"Insert date of the receiving order. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"inventory_quantities":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.V2.InventoryQuantityViewModel"},"description":"Inventory items and quantities within the WRO"},"last_updated_date":{"type":"string","format":"date-time","description":"Last date the receiving order was updated. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":["string","null"],"description":"Purchase order number for a receiving order"},"status":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"},"status_history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.V2.ReceivingOrderStatusHistoryViewModel"},"description":"The history of status changes for this receiving order"}},"title":"Receiving.V3.WarehouseReceivingOrderViewModel"},"Receiving.ProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":["integer","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]}},"title":"Receiving.ProblemDetails"},"Receiving.Post.3.0.Receiving.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Receiving.Post.3.0.Receiving.Unprocessable.Entity.Object"},"Receiving.Get.2.0.Receiving.Page.Integer":{"type":"integer","title":"Receiving.Get.2.0.Receiving.Page.Integer"},"Receiving.Get.2.0.Receiving.Limit.Integer":{"type":"integer","title":"Receiving.Get.2.0.Receiving.Limit.Integer"},"Receiving.Get.2.0.Receiving.IDs.IntegerArray":{"type":"array","items":{"type":"integer"},"title":"Receiving.Get.2.0.Receiving.IDs.IntegerArray"},"Receiving.ReceivingStatusArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"},"title":"Receiving.ReceivingStatusArray"},"Receiving.Get.2.0.Receiving.InsertStartDate.String":{"type":"string","format":"date-time","title":"Receiving.Get.2.0.Receiving.InsertStartDate.String"},"Receiving.Get.2.0.Receiving.InsertEndDate.String":{"type":"string","format":"date-time","title":"Receiving.Get.2.0.Receiving.InsertEndDate.String"},"Receiving.Get.2.0.Receiving.FulfillmentCenterIds.IntegerArray":{"type":"array","items":{"type":"integer"},"title":"Receiving.Get.2.0.Receiving.FulfillmentCenterIds.IntegerArray"},"Receiving.Get.2.0.Receiving.PurchaseOrderNumbers.StringArray":{"type":"array","items":{"type":"string"},"title":"Receiving.Get.2.0.Receiving.PurchaseOrderNumbers.StringArray"},"Receiving.Get.2.0.Receiving.ExternalSync.Boolean":{"type":"boolean","title":"Receiving.Get.2.0.Receiving.ExternalSync.Boolean"},"Receiving.Get.2.0.Receiving.CompletedStartDate.String":{"type":"string","format":"date-time","title":"Receiving.Get.2.0.Receiving.CompletedStartDate.String"},"Receiving.Get.2.0.Receiving.CompletedEndDate.String":{"type":"string","format":"date-time","title":"Receiving.Get.2.0.Receiving.CompletedEndDate.String"},"Receiving.V2.WarehouseReceivingOrderViewModel":{"type":"object","properties":{"box_labels_uri":{"type":["string","null"],"description":"URL to the packing slip to be included in each box shipment for this receiving order"},"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"expected_arrival_date":{"type":"string","format":"date-time","description":"Expected date that all packages will have arrived. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"external_sync_timestamp":{"type":["string","null"],"format":"date-time","description":"The timestamp in UTC when a 3rd party integrator has set in our system"},"final_destination_fulfillment_center_id":{"type":["integer","null"],"description":"Fulfillment center the inventory is routed to after it is received at fulfillment_center, when one was set on the receiving order. Null otherwise."},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"},"id":{"type":"integer","description":"Unique id of the warehouse receiving order"},"insert_date":{"type":"string","format":"date-time","description":"Insert date of the receiving order. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"inventory_quantities":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.V2.InventoryQuantityViewModel"},"description":"Inventory items and quantities within the WRO"},"last_updated_date":{"type":"string","format":"date-time","description":"Last date the receiving order was updated. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":["string","null"],"description":"Purchase order number for a receiving order"},"status":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"},"status_history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.V2.ReceivingOrderStatusHistoryViewModel"},"description":"The history of status changes for this receiving order"}},"title":"Receiving.V2.WarehouseReceivingOrderViewModel"},"Receiving.V2.WarehouseReceivingOrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"title":"Receiving.V2.WarehouseReceivingOrderViewModelArray"},"Receiving.ValidationProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"]},"errors":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"string"}}},"instance":{"type":["string","null"]},"status":{"type":["integer","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]}},"title":"Receiving.ValidationProblemDetails"},"Receiving.Get.3.0.Receiving.Id.Id.Integer":{"type":"integer","title":"Receiving.Get.3.0.Receiving.Id.Id.Integer"},"Receiving.FulfillmentCenterViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"},"title":"Receiving.FulfillmentCenterViewModelArray"},"Receiving.Get.2.0.Receiving.Id.Boxes.Id.Integer":{"type":"integer","title":"Receiving.Get.2.0.Receiving.Id.Boxes.Id.Integer"},"Receiving.BoxItemViewModel":{"type":"object","properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item"},"lot_date":{"type":["string","null"],"format":"date-time","description":"Expiration date of the item's lot. May be null. When present, returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"lot_number":{"type":["string","null"],"description":"Lot number the item belongs to"},"quantity":{"type":"integer","description":"Quantity of the item included"},"received_quantity":{"type":"integer","description":"Quantity of the item that was received after processing the receiving order"},"stowed_quantity":{"type":"integer","description":"Quantity of the item that has been stowed"}},"description":"Information about an item contained inside a box as part of a receiving order","title":"Receiving.BoxItemViewModel"},"Receiving.BoxStatus":{"type":"string","enum":["Awaiting","Arrived","Completed","Counting","Stowing","Cancelled","InternalTransfer"],"title":"Receiving.BoxStatus"},"Receiving.BoxViewModel":{"type":"object","properties":{"arrived_date":{"type":["string","null"],"format":"date-time","description":"Date the box arrived. May be null. When present, returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"box_id":{"type":"integer"},"box_items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.BoxItemViewModel"},"description":"Information about the items included in the box"},"box_number":{"type":"integer","description":"The number of the box in the receiving order"},"box_status":{"$ref":"#/components/schemas/Receiving.BoxStatus"},"counting_started_date":{"type":["string","null"],"format":"date-time","description":"Date counting of the box's inventory items started. May be null. When present, returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"received_date":{"type":["string","null"],"format":"date-time","description":"Date the box was received. May be null. When present, returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"tracking_number":{"type":["string","null"],"description":"Tracking number of the box shipment"}},"description":"Information about a box shipment included in a receiving order","title":"Receiving.BoxViewModel"},"Receiving.BoxViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.BoxViewModel"},"title":"Receiving.BoxViewModelArray"},"Receiving.Get.2.0.Receiving.Id.Labels.Id.Integer":{"type":"integer","title":"Receiving.Get.2.0.Receiving.Id.Labels.Id.Integer"},"Receiving_getWarehouseReceivingOrderBoxLabels_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Receiving_getWarehouseReceivingOrderBoxLabels_Response_200"},"Receiving.Post.2.0.Receiving.Id.Cancel.Id.Integer":{"type":"integer","title":"Receiving.Post.2.0.Receiving.Id.Cancel.Id.Integer"},"Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object"},"Receiving.UpdateExternalSyncModel":{"type":"object","properties":{"ids":{"type":["array","null"],"items":{"type":"integer"}},"is_external_sync":{"type":"boolean"}},"title":"Receiving.UpdateExternalSyncModel"},"Receiving.Post.2.0.Receiving.Set.External.Sync.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Receiving.Post.2.0.Receiving.Set.External.Sync.Bad.Request.Object"},"Receiving.Get.Receiving.Id.Distributions.Id.Integer":{"type":"integer","description":"Id of the receiving order","title":"Receiving.Get.Receiving.Id.Distributions.Id.Integer"},"Receiving.DistributionStatus":{"type":"string","enum":["NotStarted","InProgress","Stowing","Completed"],"title":"Receiving.DistributionStatus"},"Receiving.DistributionItem":{"type":"object","properties":{"expected_quantity":{"type":"integer","description":"Quantity to be distributed according with the transfer plan calculation"},"fulfillment_center_abbreviation":{"type":["string","null"],"description":"Abbreviation of Destination Fulfillment Center Id, including Airport Code and Sequence Number"},"fulfillment_center_id":{"type":"integer","description":"Destination Fulfillment Center Id for the item"},"inventory_id":{"type":"integer","description":"Inventory Id of the Item"},"lot_date":{"type":["string","null"],"format":"date-time","description":"Lot expiration date of the item"},"lot_number":{"type":["string","null"],"description":"Lot number of the item"},"product_sku":{"type":["string","null"],"description":"Product SKU"},"received_quantity":{"type":"integer","description":"Quantity received at hub for this item"},"status":{"$ref":"#/components/schemas/Receiving.DistributionStatus"},"stowed_quantity":{"type":"integer","description":"Quantity stowed at Destination Fulfillment Center for this item"}},"title":"Receiving.DistributionItem"},"Receiving.WarehousePickupRequestStatus":{"type":"string","enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"],"title":"Receiving.WarehousePickupRequestStatus"},"Receiving.WroDistributionDetailsResponse":{"type":"object","properties":{"distributions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.DistributionItem"},"description":"List of distribution items, for a combination of InventoryId, Lot Number, Lot Date and Destination Fulfillment Center Id"},"id":{"type":"integer","description":"Id of the receiving order"},"status":{"$ref":"#/components/schemas/Receiving.WarehousePickupRequestStatus"}},"title":"Receiving.WroDistributionDetailsResponse"},"Receiving.Get.3.0.UnidentifiedReceivingOrder.IsCompleted.Boolean":{"type":"boolean","title":"Receiving.Get.3.0.UnidentifiedReceivingOrder.IsCompleted.Boolean"},"Receiving.Get.3.0.UnidentifiedReceivingOrder.Page.Integer":{"type":"integer","title":"Receiving.Get.3.0.UnidentifiedReceivingOrder.Page.Integer"},"Receiving.V3.UroAttachmentViewModel":{"type":"object","properties":{"type":{"type":"string","description":"Attachment type, e.g. \"label\" (box/label image) or \"item\" (product image)"},"url":{"type":"string","description":"URL to the attachment image"}},"description":"An image attached to an unidentified receiving order","title":"Receiving.V3.UroAttachmentViewModel"},"Receiving.V3.UnidentifiedReceivingOrderViewModel":{"type":"object","properties":{"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V3.UroAttachmentViewModel"},"description":"Images attached to the URO. Empty array when none."},"barcode":{"type":["string","null"],"description":"URO barcode/tag"},"comment":{"type":["string","null"],"description":"Free-text comment on the URO"},"created_date":{"type":"string","format":"date-time","description":"Date the URO was created. Returned as a full RFC 3339 date-time, for example 2026-08-05T00:00:00Z."},"id":{"type":"integer","description":"Unique id of the unidentified receiving order"},"linked_wro_box_number":{"type":["integer","null"],"description":"Number of the WRO box the URO is linked to, or null when the URO is not linked"},"linked_wro_date":{"type":["string","null"],"format":"date-time","description":"Timestamp the URO was linked to a WRO, or null when not linked"},"linked_wro_id":{"type":["integer","null"],"description":"Id of the linked WRO, or null/0 when the URO is not yet linked"},"reason":{"type":["string","null"],"description":"Reason the receiving order is unidentified"},"tracking_barcode":{"type":["string","null"],"description":"Tracking barcode captured for the URO"}},"description":"Merchant-facing view of an unidentified receiving order","title":"Receiving.V3.UnidentifiedReceivingOrderViewModel"},"Receiving.V3.UnidentifiedReceivingOrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V3.UnidentifiedReceivingOrderViewModel"},"title":"Receiving.V3.UnidentifiedReceivingOrderViewModelArray"},"Receiving.Get.3.0.UnidentifiedReceivingOrder.Uroid.Integer":{"type":"integer","title":"Receiving.Get.3.0.UnidentifiedReceivingOrder.Uroid.Integer"},"Receiving.Post.3.0.UnidentifiedReceivingOrder.AssociateWRO.Uroid.Integer":{"type":"integer","title":"Receiving.Post.3.0.UnidentifiedReceivingOrder.AssociateWRO.Uroid.Integer"},"Receiving.V3.AssociateWroModel":{"type":"object","properties":{"box_number":{"type":"integer","minimum":1,"maximum":2147483647,"description":"Number of the box on the WRO to link the URO to. Required and must be greater than zero. The box must exist on the WRO, must not have arrived at a ShipBob warehouse yet, and must not already be linked to another URO."},"wro_id":{"type":"integer","minimum":1,"maximum":2147483647,"description":"Id of the WRO to link the URO to. Required and must be greater than zero."}},"required":["box_number","wro_id"],"description":"Request body for associating a URO with a specific box of a WRO","title":"Receiving.V3.AssociateWroModel"},"Receiving.Post.3.0.UnidentifiedReceivingOrder.AssociateWRO.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Receiving.Post.3.0.UnidentifiedReceivingOrder.AssociateWRO.Unprocessable.Entity.Object"},"Receiving.Patch.3.0.Receiving.Id.Id.Integer":{"type":"integer","title":"Receiving.Patch.3.0.Receiving.Id.Id.Integer"},"Receiving.V3.PatchReceivingOrderV3Model":{"type":"object","properties":{"boxes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Receiving.V3.AddBoxToOrderV3Model"},"description":"Replaces every box on this receiving order and their contents — boxes that are not included are removed, so send the complete set. Only editable while the receiving order is awaiting arrival and none of its boxes have started processing."},"expected_arrival_date":{"type":["string","null"],"format":"date-time","description":"Expected arrival date of all the box shipments in this receiving order. Must be in the future, and only editable while the receiving order is awaiting arrival and none of its boxes have started processing."},"final_destination_fulfillment_center_id":{"type":["integer","null"],"minimum":1,"description":"Fulfillment center the inventory is routed to after it is received at fulfillment_center, such as a spoke site served by a receiving hub. Only allowed for certain fulfillment centers and merchants. Fees may apply when routing to it requires cross-region transportation. Only editable while the receiving order is awaiting arrival and none of its boxes have started processing."},"fulfillment_center":{"oneOf":[{"$ref":"#/components/schemas/Receiving.AssignOrderToFulfillmentCenterModel"},{"type":"null"}],"description":"Fulfillment center this receiving order is being shipped to. Only editable while the receiving order is awaiting arrival and none of its boxes have started processing. Wrapped in allOf so the nullability applies: in OpenAPI 3.0 a keyword alongside $ref is ignored."},"purchase_order_number":{"type":["string","null"],"description":"Purchase order number for this receiving order. Send an empty or blank string to clear it. Surrounding whitespace is trimmed. Editable in any status except complete."}},"description":"Changes to apply to an existing receiving order. Every field is optional — omit a field, or send it as null, to leave it unchanged. A request must carry at least one field with a value: a body that is empty, or whose every field is null, is rejected. Resubmitting values that already match the order is accepted and simply changes nothing, so the same request can safely be sent twice. minProperties only catches the empty object, since OpenAPI cannot express \"at least one non-null property\".","title":"Receiving.V3.PatchReceivingOrderV3Model"},"Receiving.Patch.3.0.Receiving.Id.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Receiving.Patch.3.0.Receiving.Id.Unprocessable.Entity.Object"},"Receiving.Patch.3.0.Receiving.Id.Tracking.Id.Integer":{"type":"integer","title":"Receiving.Patch.3.0.Receiving.Id.Tracking.Id.Integer"},"Receiving.V3.UpdateBoxTrackingV3Model":{"type":"object","properties":{"box_number":{"type":"integer","minimum":1,"description":"The box's number on the receiving order (1-based)."},"tracking_number":{"type":"string","minLength":1,"maxLength":100,"description":"New tracking number for the box; must be unique across all boxes of the order."}},"required":["box_number","tracking_number"],"description":"A box's new tracking number, addressed by its box number on the order.","title":"Receiving.V3.UpdateBoxTrackingV3Model"},"Receiving.V3.UpdateReceivingOrderTrackingV3Model":{"type":"object","properties":{"boxes":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V3.UpdateBoxTrackingV3Model"},"description":"Boxes to update, addressed by box number."},"other_carrier_name":{"type":["string","null"],"maxLength":50,"description":"Free-text carrier name (max 50 characters); required when vendor_carrier_name is \"Other\", not valid otherwise."},"vendor_carrier_name":{"type":"string","minLength":1,"maxLength":450,"description":"Carrier delivering the listed boxes, from the ShipBob vendor-carrier list, or the literal \"Other\" with the carrier name supplied in other_carrier_name."}},"required":["boxes","vendor_carrier_name"],"description":"Tracking update for a warehouse receiving order: per-box tracking numbers plus the carrier delivering them. Boxes not listed are left unchanged; the carrier applies to every listed box. Not available when ShipBob shipping labels were purchased for the order.","title":"Receiving.V3.UpdateReceivingOrderTrackingV3Model"},"Receiving.V3.BoxTrackingV3ViewModel":{"type":"object","properties":{"box_id":{"type":"integer","description":"Id of the box"},"box_number":{"type":"integer","description":"The box's number on the receiving order (1-based)"},"other_carrier_name":{"type":["string","null"],"description":"Free-text carrier name when vendor_carrier_name is \"Other\""},"tracking_number":{"type":["string","null"],"description":"Tracking number of the box shipment"},"vendor_carrier_name":{"type":["string","null"],"description":"Carrier delivering the box, or \"Other\""}},"description":"Tracking state of one box.","title":"Receiving.V3.BoxTrackingV3ViewModel"},"Receiving.V3.WarehouseReceivingOrderTrackingV3ViewModel":{"type":"object","properties":{"boxes":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V3.BoxTrackingV3ViewModel"},"description":"Tracking state of every box on the order"},"id":{"type":"integer","description":"Id of the receiving order"}},"description":"Per-box tracking state of a warehouse receiving order after a tracking update.","title":"Receiving.V3.WarehouseReceivingOrderTrackingV3ViewModel"},"Receiving.Patch.3.0.Receiving.Id.Tracking.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"title":"Receiving.Patch.3.0.Receiving.Id.Tracking.Unprocessable.Entity.Object"},"Returns.Post.Return.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Returns.Post.Return.Shipbob.Channel.Id.Integer"},"Returns.Facility":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the facility"},"name":{"type":["string","null"],"description":"Name of the facility (It is optional because public API integrations do not pass this)"}},"required":["id"],"description":"A Facility to process Returns.","title":"Returns.Facility"},"Returns.ReturnAction":{"type":"string","enum":["Default","Restock","Quarantine","Dispose","Donation"],"title":"Returns.ReturnAction"},"Returns.ReturnInventory":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the inventory item to return."},"lot_date":{"type":["string","null"],"format":"date-time","description":"Lot date associated with the inventory item, if applicable."},"lot_number":{"type":["string","null"],"description":"Lot number associated with the inventory item, if applicable."},"quantity":{"type":"integer","description":"Quantity of the returned inventory item in the return."},"requested_action":{"$ref":"#/components/schemas/Returns.ReturnAction"}},"required":["id","quantity","requested_action"],"description":"An inventory being returned, includes the quantity and an override for the return action.","title":"Returns.ReturnInventory"},"Returns.CreateReturnRequest":{"type":"object","properties":{"fulfillment_center":{"$ref":"#/components/schemas/Returns.Facility"},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnInventory"},"description":"Array of inventory items being returned"},"original_shipment_id":{"type":["integer","null"],"description":"Shipment from which the items in the return originated <example>123456</example>"},"reference_id":{"type":"string","minLength":1,"maxLength":50,"description":"Client-defined external unique identifier for the return order.\r\n            If tracking id is not provided, this value must appear on the box label as RMA. <example>Example: ShipBob_Return_123</example>"},"tracking_number":{"type":["string","null"],"maxLength":500,"description":"Tracking number for the return shipment <example>1Z9999999999999999</example>"}},"required":["fulfillment_center","inventory","reference_id"],"description":"The request payload for creating a Return of inventory.","title":"Returns.CreateReturnRequest"},"Returns.ChannelDto":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id of the channel"},"name":{"type":["string","null"],"description":"Name given to the channel"}},"description":"The details of a Channel","title":"Returns.ChannelDto"},"Returns.FulfillmentCenterDto":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the fulfillment center"},"name":{"type":["string","null"],"description":"Name give to the fulfillment center"}},"description":"The details of a Fulfillment Center","title":"Returns.FulfillmentCenterDto"},"Returns.ActionRequestedDto":{"type":"object","properties":{"action":{"type":["string","null"],"description":"The action to take"},"action_type":{"type":["string","null"],"description":"The source of the action to take, i.e. Inventory Default or Overriden by Merchant at creation"},"instructions":{"type":["string","null"],"description":"The instructions for how to take the action given by inventory owning Merchant"}},"description":"The details of the action requested for inventory","title":"Returns.ActionRequestedDto"},"Returns.ActionTakenDto":{"type":"object","properties":{"action":{"type":["string","null"],"description":"The return action taken"},"action_reason":{"type":["string","null"],"description":"The reason the action was taken"},"image_url":{"type":["string","null"],"format":"uri","description":"Image of inventory processed with this action."},"quantity_processed":{"type":"integer","description":"The quantity of inventory items processed with this reason and action"}},"description":"The details of an action taken for inventory item in the return","title":"Returns.ActionTakenDto"},"Returns.InventoryItemV1Dto":{"type":"object","properties":{"action_requested":{"$ref":"#/components/schemas/Returns.ActionRequestedDto"},"action_taken":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.ActionTakenDto"},"description":"List of actions taken"},"bundle_parent_sku":{"type":["string","null"],"description":"SKU of the parent bundle if this item was expanded from a bundle. Null for non-bundle items"},"id":{"type":"integer","description":"Unique id of the inventory"},"name":{"type":["string","null"],"description":"Name of the product"},"quantity":{"type":"integer","description":"Number of inventory that is being returned"}},"description":"The details of the inventory in the return order","title":"Returns.InventoryItemV1Dto"},"Returns.TransactionDto":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The amount charged for this transaction"},"transaction_type":{"type":["string","null"],"description":"The type of transaction"}},"description":"The details of a transaction charged to the return order","title":"Returns.TransactionDto"},"Returns.PublicReturnV1Dto":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Returns.ChannelDto"},"completed_date":{"type":["string","null"],"format":"date-time","description":"The date and time for when the return order was completely processed"},"customer_name":{"type":["string","null"],"description":"Name of merchant that return belongs to"},"fulfillment_center":{"$ref":"#/components/schemas/Returns.FulfillmentCenterDto"},"id":{"type":"integer","description":"Unique id of the return order"},"insert_date":{"type":"string","format":"date-time","description":"The date and time for when the return order was created"},"inventory":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.InventoryItemV1Dto"},"description":"List of inventory items in return order"},"invoice_amount":{"type":["number","null"],"format":"double","description":"Amount merchant was invoiced for processing the return"},"original_shipment_id":{"type":["integer","null"],"description":"ShipmentId for which return was created"},"reference_id":{"type":["string","null"],"description":"Unique reference id of the return order. Created by merchant if a regular return."},"return_type":{"type":["string","null"],"description":"Type of the return, i.e. Regular, RTS"},"status":{"type":["string","null"],"description":"Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`"},"store_order_id":{"type":["string","null"],"description":"Reference to external order id"},"tracking_number":{"type":["string","null"],"description":"The tracking number of the return shipping label"},"transactions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.TransactionDto"},"description":"List of transactions that make up the billable amount to invoice a merchant"}},"description":"The details of a public return order (V1), including the transactions and inventory items","title":"Returns.PublicReturnV1Dto"},"Returns.ProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":["integer","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]}},"title":"Returns.ProblemDetails"},"Returns.ApiError":{"type":"object","properties":{"details":{"oneOf":[{"description":"Any type"},{"type":"null"}]},"errors":{"type":["array","null"],"items":{"type":"string"}},"message":{"type":["string","null"]},"stackTrace":{"type":["string","null"],"description":"StackTrace of the Exception"}},"title":"Returns.ApiError"},"Returns.Get.Return.Ids.String":{"type":"string","title":"Returns.Get.Return.Ids.String"},"Returns.Get.Return.ReferenceIds.String":{"type":"string","title":"Returns.Get.Return.ReferenceIds.String"},"Returns.Get.Return.Status.String":{"type":"string","title":"Returns.Get.Return.Status.String"},"Returns.Get.Return.FulfillmentCenterIds.String":{"type":"string","title":"Returns.Get.Return.FulfillmentCenterIds.String"},"Returns.Get.Return.TrackingNumbers.String":{"type":"string","title":"Returns.Get.Return.TrackingNumbers.String"},"Returns.Get.Return.OriginalShipmentIds.String":{"type":"string","title":"Returns.Get.Return.OriginalShipmentIds.String"},"Returns.Get.Return.InventoryIds.String":{"type":"string","title":"Returns.Get.Return.InventoryIds.String"},"Returns.Get.Return.StartDate.String":{"type":"string","format":"date-time","title":"Returns.Get.Return.StartDate.String"},"Returns.Get.Return.EndDate.String":{"type":"string","format":"date-time","title":"Returns.Get.Return.EndDate.String"},"Returns.Get.Return.ReturnTypes.String":{"type":"string","title":"Returns.Get.Return.ReturnTypes.String"},"Returns.Get.Return.ReturnActions.String":{"type":"string","title":"Returns.Get.Return.ReturnActions.String"},"Returns.Get.Return.StoreOrderIds.String":{"type":"string","title":"Returns.Get.Return.StoreOrderIds.String"},"Returns.Get.Return.Sortby.String":{"type":"string","title":"Returns.Get.Return.Sortby.String"},"Returns.Get.Return.CompletedStartDate.String":{"type":"string","format":"date-time","title":"Returns.Get.Return.CompletedStartDate.String"},"Returns.Get.Return.CompletedEndDate.String":{"type":"string","format":"date-time","title":"Returns.Get.Return.CompletedEndDate.String"},"Returns.Get.Return.Cursor.Integer":{"type":"integer","minimum":1,"maximum":2147483647,"title":"Returns.Get.Return.Cursor.Integer"},"Returns.Get.Return.Limit.Integer":{"type":"integer","title":"Returns.Get.Return.Limit.Integer"},"202607ReturnGetParametersSortOrder":{"type":"string","enum":["Asc","Desc"],"title":"202607ReturnGetParametersSortOrder"},"Returns.Get.Return.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Returns.Get.Return.Shipbob.Channel.Id.Integer"},"Returns.LotInformationDto":{"type":"object","properties":{"expiration":{"type":["string","null"],"format":"date-time","description":"The expiration date for this lot."},"minimumShelfLife":{"type":["integer","null"],"description":"A minimum amount of time in days this product can be safely returned to the shelf without expiring."},"number":{"type":["string","null"],"description":"An alphanumeric string uniquely identifying this lot of produced inventory."}},"description":"Lot information associated with a specific inventory item.","title":"Returns.LotInformationDto"},"Returns.InventoryItemDto":{"type":"object","properties":{"action_requested":{"$ref":"#/components/schemas/Returns.ActionRequestedDto"},"action_taken":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.ActionTakenDto"},"description":"List of actions taken"},"barcodes":{"type":["array","null"],"items":{"type":"string"},"description":"List of barcodes associated with the inventory item"},"bundle_parent_sku":{"type":["string","null"],"description":"SKU of the parent bundle if this item was expanded from a bundle. Null for non-bundle items"},"id":{"type":"integer","description":"Unique id of the inventory"},"lot_information":{"$ref":"#/components/schemas/Returns.LotInformationDto"},"name":{"type":["string","null"],"description":"Name of the product"},"quantity":{"type":"integer","description":"Number of inventory that is being returned"},"sku":{"type":["string","null"],"description":"Stock keeping unit identifier for the inventory item"}},"description":"The details of the inventory in the return order","title":"Returns.InventoryItemDto"},"Returns.InvoiceDto":{"type":"object","properties":{"amount":{"type":["number","null"],"format":"double","description":"Amount being charged"},"currency_code":{"type":["string","null"],"description":"Currency code of amount"}},"description":"The invoice amount and curency","title":"Returns.InvoiceDto"},"Returns.StatusHistoryDto":{"type":"object","properties":{"status":{"type":["string","null"],"description":"Status to change"},"timestamp":{"type":"string","format":"date-time","description":"Date change status"}},"description":"Status history","title":"Returns.StatusHistoryDto"},"Returns.PublicReturnDto":{"type":"object","properties":{"arrived_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the return arrived at the fulfillment center"},"awaiting_arrival_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the return entered Awaiting Arrival status"},"cancelled_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the return was cancelled, if applicable"},"channel":{"$ref":"#/components/schemas/Returns.ChannelDto"},"completed_date":{"type":["string","null"],"format":"date-time","description":"The date and time for when the return order was completely processed"},"customer_name":{"type":["string","null"],"description":"Name of merchant that return belongs to"},"fulfillment_center":{"$ref":"#/components/schemas/Returns.FulfillmentCenterDto"},"id":{"type":"integer","description":"Unique id of the return order"},"insert_date":{"type":"string","format":"date-time","description":"The date and time for when the return order was created"},"inventory":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.InventoryItemDto"},"description":"List of inventory items in return order"},"invoice":{"$ref":"#/components/schemas/Returns.InvoiceDto"},"original_shipment_id":{"type":["integer","null"],"description":"ShipmentId for which return was created"},"processing_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the return started processing"},"reference_id":{"type":["string","null"],"description":"Unique reference id of the return order. Created by merchant if a regular return."},"return_type":{"type":["string","null"],"description":"Type of the return, i.e. Regular, RTS"},"shipment_tracking_number":{"type":["string","null"],"description":"The tracking number of the original shipment"},"status":{"type":["string","null"],"description":"Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`"},"status_history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.StatusHistoryDto"},"description":"List of status history in return order"},"store_order_id":{"type":["string","null"],"description":"Reference to external order id"},"tracking_number":{"type":["string","null"],"description":"The tracking number of the return shipping label"},"transactions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.TransactionDto"},"description":"List of transactions that make up the billable amount to invoice a merchant"}},"description":"The details of a public return order, including the transactions and inventory items","title":"Returns.PublicReturnDto"},"Returns.PublicReturnDtoPagedUrlResultDto":{"type":"object","properties":{"first":{"type":["string","null"],"format":"uri","description":"Return url for first cursor"},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Returns.PublicReturnDto"},"description":"Return records"},"last":{"type":["string","null"],"format":"uri","description":"Return url for last cursor"},"next":{"type":["string","null"],"format":"uri","description":"Return url for next cursor"},"prev":{"type":["string","null"],"format":"uri","description":"Return url for prev cursor"}},"title":"Returns.PublicReturnDtoPagedUrlResultDto"},"Returns.Get.Return.Id.Id.Integer":{"type":"integer","title":"Returns.Get.Return.Id.Id.Integer"},"Returns.Get.Return.Id.Shipbob.Channel.Id.Integer":{"type":"integer","title":"Returns.Get.Return.Id.Shipbob.Channel.Id.Integer"},"Returns.Put.Api.Public.Id.Id.Integer":{"type":"integer","title":"Returns.Put.Api.Public.Id.Id.Integer"},"Returns.Post.Api.Public.Cancel.Id.Id.Integer":{"type":"integer","title":"Returns.Post.Api.Public.Cancel.Id.Id.Integer"},"Returns_cancelReturnOrder_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Returns_cancelReturnOrder_Response_200"},"Webhooks.Topics":{"type":"string","enum":["order.shipped","order.delivered","order.shipment.delivered","order.shipment.exception","order.shipment.on_hold","order.shipment.cancelled","order.shipment.tracking.updated","order.shipment.address.updated","order.shipment.line_item.added","order.shipment.line_item.removed","order.shipment.line_item.updated","order.shipment.shipping_service.updated","return.created","return.updated","return.completed","return.load_shipment.departed","return.gaylord.departed","return.load_shipment.arrived","return.gaylord.arrived","return.gaylord.stow_completed","billing.charge.created","billing.refund.created","billing.credit.created","wro.box.arrived","wro.box.scanned","wro.box.stowed","wro.completed","wro.created","wro.updated"],"title":"Webhooks.Topics"},"Webhooks.V2.CreateSubscriptionRequest":{"type":"object","properties":{"description":{"type":["string","null"],"description":"Description of the webhook subscription."},"secret":{"type":["string","null"],"pattern":"^whsec_[a-zA-Z0-9+/]{32}$","description":"A secret key used to sign the webhook payload for verifying its authenticity on the receiver's end."},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Topics"},"description":"The event types for which webhook callbacks will be received."},"url":{"type":"string","format":"uri","description":"The URL that will be called when an event matching the subscription topic occurs.\r\nThe URL must use HTTPS, accept POST requests, and handle content of type application/json."}},"required":["topics","url"],"title":"Webhooks.V2.CreateSubscriptionRequest"},"Webhooks.V2.Create.WebhookViewModelV2":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"TimeStamp the webhook subscription was created"},"description":{"type":["string","null"],"description":"Description of the webhook subscription"},"id":{"type":"string","description":"ID of the webhook subscription"},"secret":{"type":"string","pattern":"^whsec_[a-zA-Z0-9+/]{32}$","description":"A secret key used to sign the webhook payload for verifying its authenticity on the receiver's end."},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Topics"},"description":"List of event types the webhook will receive notifications for"},"url":{"type":"string","description":"URL subscription events will be posted to"}},"title":"Webhooks.V2.Create.WebhookViewModelV2"},"WebhooksUnprocessableEntityObjectResultDeclaredType1":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType1"},"WebhooksUnprocessableEntityObjectResultDeclaredType9":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType9"},"WebhooksUnprocessableEntityObjectResultDeclaredType10":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType10"},"WebhooksUnprocessableEntityObjectResultDeclaredType124":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType124"},"WebhooksUnprocessableEntityObjectResultDeclaredType125":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType125"},"WebhooksUnprocessableEntityObjectResultDeclaredType12":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType124"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType125"},{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType12"},"WebhooksUnprocessableEntityObjectResultDeclaredType144":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType144"},"WebhooksUnprocessableEntityObjectResultDeclaredType146":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType146"},"WebhooksUnprocessableEntityObjectResultDeclaredType147":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType147"},"WebhooksUnprocessableEntityObjectResultDeclaredType14":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType144"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType146"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType147"},{"type":"string"},{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType14"},"WebhooksUnprocessableEntityObjectResultDeclaredType17":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType17"},"WebhooksUnprocessableEntityObjectResultDeclaredType19":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType19"},"WebhooksUnprocessableEntityObjectResultDeclaredType20":{"oneOf":[{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType20"},"WebhooksUnprocessableEntityObjectResultDeclaredType":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType1"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType9"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType10"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType12"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType14"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType17"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType19"},{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType20"},{"type":"string"},{"type":"string"}],"title":"WebhooksUnprocessableEntityObjectResultDeclaredType"},"Webhooks.IOutputFormatter":{"type":"object","properties":{},"title":"Webhooks.IOutputFormatter"},"WebhooksUnprocessableEntityObjectResultValue":{"type":"object","properties":{},"title":"WebhooksUnprocessableEntityObjectResultValue"},"Webhooks.UnprocessableEntityObjectResult":{"type":"object","properties":{"$type":{"type":"string"},"content_types":{"type":["array","null"],"items":{"type":"string"}},"declared_type":{"oneOf":[{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultDeclaredType"},{"type":"null"}]},"formatters":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Webhooks.IOutputFormatter"}},"status_code":{"type":["integer","null"]},"value":{"oneOf":[{"$ref":"#/components/schemas/WebhooksUnprocessableEntityObjectResultValue"},{"type":"null"}]}},"required":["$type"],"title":"Webhooks.UnprocessableEntityObjectResult"},"Webhooks.Get.V2.Webhook.RecordsPerPage.Integer":{"type":"integer","minimum":1,"maximum":250,"description":"Number of webhooks returned per page in a paginated response.","title":"Webhooks.Get.V2.Webhook.RecordsPerPage.Integer"},"Webhooks.Get.V2.Webhook.Cursor.String":{"type":"string","description":"[Optional] A pagination token used to retrieve the next or previous page of results. Omit to start at the first page.","title":"Webhooks.Get.V2.Webhook.Cursor.String"},"Webhooks.V2.WebhookViewModelV2":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"TimeStamp the webhook subscription was created"},"description":{"type":["string","null"],"description":"Description of the webhook subscription"},"enabled":{"type":"boolean","description":"Indicates if the webhook subscription is enabled or not"},"id":{"type":"string","description":"ID of the webhook subscription"},"topics":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.Topics"},"description":"List of event types the webhook will receive notifications for"},"url":{"type":"string","description":"URL subscription events will be posted to"}},"title":"Webhooks.V2.WebhookViewModelV2"},"Webhooks.GetWebhookResponse":{"type":"object","properties":{"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Webhooks.V2.WebhookViewModelV2"}},"next":{"type":["string","null"],"description":"Go to the Next page"},"prev":{"type":["string","null"],"description":"Go to the Previous page"}},"title":"Webhooks.GetWebhookResponse"},"WebhooksBadRequestObjectResultDeclaredType1":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType1"},"WebhooksBadRequestObjectResultDeclaredType9":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType9"},"WebhooksBadRequestObjectResultDeclaredType10":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType10"},"WebhooksBadRequestObjectResultDeclaredType124":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType124"},"WebhooksBadRequestObjectResultDeclaredType125":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType125"},"WebhooksBadRequestObjectResultDeclaredType12":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType124"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType125"},{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType12"},"WebhooksBadRequestObjectResultDeclaredType144":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType144"},"WebhooksBadRequestObjectResultDeclaredType146":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType146"},"WebhooksBadRequestObjectResultDeclaredType147":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType147"},"WebhooksBadRequestObjectResultDeclaredType14":{"oneOf":[{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType144"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType146"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType147"},{"type":"string"},{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType14"},"WebhooksBadRequestObjectResultDeclaredType17":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType17"},"WebhooksBadRequestObjectResultDeclaredType19":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType19"},"WebhooksBadRequestObjectResultDeclaredType20":{"oneOf":[{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType20"},"WebhooksBadRequestObjectResultDeclaredType":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType1"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType9"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType10"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType12"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType14"},{"type":"string"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType17"},{"type":"string"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType19"},{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType20"},{"type":"string"},{"type":"string"}],"title":"WebhooksBadRequestObjectResultDeclaredType"},"WebhooksBadRequestObjectResultValue":{"type":"object","properties":{},"title":"WebhooksBadRequestObjectResultValue"},"Webhooks.BadRequestObjectResult":{"type":"object","properties":{"$type":{"type":"string"},"content_types":{"type":["array","null"],"items":{"type":"string"}},"declared_type":{"oneOf":[{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultDeclaredType"},{"type":"null"}]},"formatters":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Webhooks.IOutputFormatter"}},"status_code":{"type":["integer","null"]},"value":{"oneOf":[{"$ref":"#/components/schemas/WebhooksBadRequestObjectResultValue"},{"type":"null"}]}},"required":["$type"],"title":"Webhooks.BadRequestObjectResult"},"Webhooks.Delete.V2.Webhook.Id.Id.String":{"type":"string","description":"This is the id of the webhook subscription to delete","title":"Webhooks.Delete.V2.Webhook.Id.Id.String"},"Locations.Get.1.0.Location.IncludeInactive.Boolean":{"type":"boolean","description":"Whether the inactive locations should be included or not","title":"Locations.Get.1.0.Location.IncludeInactive.Boolean"},"Locations.Get.1.0.Location.ReceivingEnabled.Boolean":{"type":"boolean","description":"Return all the receiving enabled locations","title":"Locations.Get.1.0.Location.ReceivingEnabled.Boolean"},"Locations.Get.1.0.Location.AccessGranted.Boolean":{"type":"boolean","description":"Return all the access granted locations","title":"Locations.Get.1.0.Location.AccessGranted.Boolean"},"Locations.FulfillmentCenterRegionViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id for the location region"},"name":{"type":["string","null"],"description":"Name of the region the location is in."}},"title":"Locations.FulfillmentCenterRegionViewModel"},"Locations.AddressViewModel":{"type":"object","properties":{"address1":{"type":["string","null"],"description":"First part of the address of the location for this service"},"address2":{"type":["string","null"],"description":"Second part of the address of the location for this service"},"city":{"type":["string","null"],"description":"City of the location"},"country":{"type":["string","null"],"description":"Country of the location"},"email":{"type":["string","null"],"description":"Email of the location for this service"},"name":{"type":["string","null"],"description":"Name to use in the address of the location for this service"},"phone_number":{"type":["string","null"],"description":"Phone Number of the location for this service"},"state":{"type":["string","null"],"description":"State of the location"},"zip_code":{"type":["string","null"],"description":"Zip code of the location"}},"description":"The service-specific address of the location. Each object contains address type, address1, address2, city, state, country, zip code, phone number, and email","title":"Locations.AddressViewModel"},"Locations.ServiceTypeEnum":{"type":"string","enum":["Receiving","Returns"],"title":"Locations.ServiceTypeEnum"},"Locations.ServiceViewModel":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Locations.AddressViewModel"},"enabled":{"type":"boolean","description":"Indicates if the user is authorized to access this service at the location"},"service_type":{"$ref":"#/components/schemas/Locations.ServiceTypeEnum"}},"title":"Locations.ServiceViewModel"},"Locations.LocationViewModel":{"type":"object","properties":{"abbreviation":{"type":["string","null"],"description":"Abbreviation of the location. Combination of nearest Airport Code and the sequence number."},"access_granted":{"type":"boolean","description":"Indicates whether or not the user is authorized to interact at all with the location"},"attributes":{"type":["array","null"],"items":{"type":"string"},"description":"Available attributes for the location"},"id":{"type":"integer","description":"Id of the location in ShipBob’s database"},"is_active":{"type":"boolean","description":"Indicates if the location is operationally active or inactive"},"is_receiving_enabled":{"type":"boolean","description":"Indicates if the receiving is enabled for FC"},"is_shipping_enabled":{"type":"boolean","description":"Indicates if the shipping is enabled for FC"},"name":{"type":["string","null"],"description":"Name of the location. Follows the naming convention City (State Code)\r\nfor domestic FCs and City (Country Code) for international FCs"},"region":{"$ref":"#/components/schemas/Locations.FulfillmentCenterRegionViewModel"},"services":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Locations.ServiceViewModel"},"description":"Services provided by the location"},"timezone":{"type":["string","null"],"description":"Time zone of the location"}},"title":"Locations.LocationViewModel"},"Locations.Get.1.0.Location.OK.OneOfArray":{"type":"array","items":{"$ref":"#/components/schemas/Locations.LocationViewModel"},"title":"Locations.Get.1.0.Location.OK.OneOfArray"},"Billing.Post.Api.V3.Transactions.Query.Cursor.String":{"type":"string","description":"Cursor for pagination. Used to retrieve the next set of transaction query results.","title":"Billing.Post.Api.V3.Transactions.Query.Cursor.String"},"BillingTransactionRequestFilterV3ReferenceTypesItems":{"type":"string","enum":["Shipment","Return","WRO","URO"],"title":"BillingTransactionRequestFilterV3ReferenceTypesItems"},"Billing.SortOrder":{"type":"string","enum":["Ascending","Descending"],"default":"Descending","description":"Sort order for results. Ascending sorts from lowest to highest, Descending sorts from highest to lowest.","title":"Billing.SortOrder"},"BillingTransactionRequestFilterV3TransactionTypesItems":{"type":"string","enum":["Charge","Refund","Credit","Payment","BalanceAdjustment"],"title":"BillingTransactionRequestFilterV3TransactionTypesItems"},"Billing.TransactionRequestFilterV3":{"type":"object","properties":{"from_date":{"type":["string","null"],"format":"date-time","description":"Start date for filtering transactions by charge date. Defaults to 7 days before the current date if not specified."},"invoice_ids":{"type":["array","null"],"items":{"type":"string"},"description":"List of invoice IDs to filter transactions by."},"invoiced_status":{"type":["boolean","null"],"description":"Filter transactions by invoicing status. True returns billed transactions, false returns unbilled transactions, and null returns both billed and unbilled transactions."},"page_size":{"type":"integer","description":"Number of transactions to return per page. Default is 100. Must be between 1 and 1000."},"reference_ids":{"type":["array","null"],"items":{"type":"string"},"description":"List of reference IDs (such as Shipment IDs, WRO IDs) to filter transactions. Can be numeric or string identifiers."},"reference_types":{"type":["array","null"],"items":{"$ref":"#/components/schemas/BillingTransactionRequestFilterV3ReferenceTypesItems"},"description":"The types of references associated with the reference IDs to filter by."},"sort_order":{"$ref":"#/components/schemas/Billing.SortOrder","default":"Descending"},"to_date":{"type":["string","null"],"format":"date-time","description":"End date for filtering transactions by charge date. Defaults to the current date if not specified."},"transaction_fees":{"type":["array","null"],"items":{"type":"string"},"description":"List of transaction fee types to filter by. To get all available transaction fees, use the '/transaction-fees' endpoint."},"transaction_types":{"type":["array","null"],"items":{"$ref":"#/components/schemas/BillingTransactionRequestFilterV3TransactionTypesItems"},"description":"The classification or nature of the transactions to filter by."}},"title":"Billing.TransactionRequestFilterV3"},"BillingTransactionDtoV3InvoiceType":{"type":"string","enum":["Shipping","Inbound Fee","WarehouseStorage","AdditionalFee","Return","Credits","BalanceAdjustment","Payment"],"description":"The type or category of the invoice.","title":"BillingTransactionDtoV3InvoiceType"},"BillingTransactionDtoV3ReferenceType":{"type":"string","enum":["Shipment","Return","WRO","URO","Ticket Number","FC","LPN Reference","Transfer Plan"],"description":"The type of reference associated with the reference ID.","title":"BillingTransactionDtoV3ReferenceType"},"Billing.InvoiceTaxDtoV3":{"type":"object","properties":{"tax_amount":{"type":"number","format":"double","description":"Tax amount charged for this tax type."},"tax_rate":{"type":"number","format":"double","description":"Tax rate applied as a percentage."},"tax_type":{"type":["string","null"],"description":"Type of tax applied."}},"description":"Tax information associated with a transaction or invoice.","title":"Billing.InvoiceTaxDtoV3"},"BillingTransactionDtoV3TransactionType":{"type":"string","enum":["Charge","Refund","Credit","Payment","BalanceAdjustment"],"description":"The classification or nature of the transaction.","title":"BillingTransactionDtoV3TransactionType"},"Billing.TransactionDtoV3":{"type":"object","properties":{"additional_details":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Any additional details related to the transaction in a key-value pair format."},"amount":{"type":["number","null"],"format":"double","description":"The charge amount for the transaction."},"charge_date":{"type":["string","null"],"description":"The date when the transaction was charged."},"currency_code":{"type":["string","null"],"description":"The ISO currency code (e.g., USD, EUR) for the transaction."},"fulfillment_center":{"type":["string","null"],"description":"The name or code of the fulfillment center involved in the transaction."},"invoice_date":{"type":["string","null"],"description":"The date the invoice was generated."},"invoice_id":{"type":["integer","null"],"description":"The unique identifier of the invoice associated with this transaction."},"invoice_type":{"oneOf":[{"$ref":"#/components/schemas/BillingTransactionDtoV3InvoiceType"},{"type":"null"}],"description":"The type or category of the invoice."},"invoiced_status":{"type":["boolean","null"],"description":"Indicates whether the transaction has been invoiced. True if billed, false if unbilled."},"reference_id":{"type":["string","null"],"description":"A unique reference identifier associated with the transaction."},"reference_type":{"oneOf":[{"$ref":"#/components/schemas/BillingTransactionDtoV3ReferenceType"},{"type":"null"}],"description":"The type of reference associated with the reference ID."},"taxes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Billing.InvoiceTaxDtoV3"},"description":"A list of tax details applied to the transaction, if any exist."},"transaction_fee":{"type":["string","null"],"description":"The fee type associated with the transaction. To get all available transaction fees, use the '/transaction-fees' endpoint."},"transaction_id":{"type":["string","null"],"description":"The unique identifier for the transaction."},"transaction_type":{"oneOf":[{"$ref":"#/components/schemas/BillingTransactionDtoV3TransactionType"},{"type":"null"}],"description":"The classification or nature of the transaction."}},"description":"Represents a transaction data object.","title":"Billing.TransactionDtoV3"},"Billing.TransactionDtoCursorPagedResponseV3":{"type":"object","properties":{"first":{"type":["string","null"],"description":"Go to the first page"},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Billing.TransactionDtoV3"}},"last":{"type":["string","null"],"description":"Go to the Last page"},"next":{"type":["string","null"],"description":"Go to the Next page"},"prev":{"type":["string","null"],"description":"Go to the Previous page"}},"title":"Billing.TransactionDtoCursorPagedResponseV3"},"Billing.ProblemDetails":{"type":"object","properties":{"detail":{"type":["string","null"]},"instance":{"type":["string","null"]},"status":{"type":["integer","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]}},"title":"Billing.ProblemDetails"},"Billing.Get.Api.V3.Invoices.Cursor.String":{"type":"string","description":"Cursor for pagination. Used to retrieve the next set of invoice results.","title":"Billing.Get.Api.V3.Invoices.Cursor.String"},"Billing.Get.Api.V3.Invoices.FromDate.String":{"type":"string","format":"date-time","description":"Start date for filtering invoices. Must be in ISO 8601 date-time format.","title":"Billing.Get.Api.V3.Invoices.FromDate.String"},"Billing.Get.Api.V3.Invoices.ToDate.String":{"type":"string","format":"date-time","description":"End date for filtering invoices. Must be in ISO 8601 date-time format.","title":"Billing.Get.Api.V3.Invoices.ToDate.String"},"BillingGetApiV3InvoicesInvoiceTypesStringArrayItems":{"type":"string","enum":["Shipping","WarehouseStorage","Inbound Fee","Return","AdditionalFee","Credits"],"title":"BillingGetApiV3InvoicesInvoiceTypesStringArrayItems"},"Billing.Get.Api.V3.Invoices.InvoiceTypes.StringArray":{"type":"array","items":{"$ref":"#/components/schemas/BillingGetApiV3InvoicesInvoiceTypesStringArrayItems"},"description":"Array of invoice types for filtering.","title":"Billing.Get.Api.V3.Invoices.InvoiceTypes.StringArray"},"Billing.Get.Api.V3.Invoices.PageSize.Integer":{"type":"integer","default":100,"description":"Number of invoices to return per page. Default is 100. Must be between 1 and 1000.","title":"Billing.Get.Api.V3.Invoices.PageSize.Integer"},"BillingInvoiceDtoV3InvoiceType":{"type":"string","enum":["Shipping","Inbound Fee","WarehouseStorage","AdditionalFee","Return","Credits","BalanceAdjustment","Payment"],"description":"The type or category of the invoice.","title":"BillingInvoiceDtoV3InvoiceType"},"Billing.InvoiceDtoV3":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The total invoice amount."},"currency_code":{"type":["string","null"],"description":"The ISO currency code used in the invoice (e.g., USD, EUR)."},"invoice_date":{"type":["string","null"],"description":"The invoice date in yyyy-mm-dd format."},"invoice_id":{"type":"integer","description":"Unique identifier for the invoice."},"invoice_type":{"oneOf":[{"$ref":"#/components/schemas/BillingInvoiceDtoV3InvoiceType"},{"type":"null"}],"description":"The type or category of the invoice."},"running_balance":{"type":"number","format":"double","description":"The running balance of the account after this invoice is applied."}},"description":"Data transfer object representing an invoice.","title":"Billing.InvoiceDtoV3"},"Billing.InvoiceDtoCursorPagedResponseV3":{"type":"object","properties":{"first":{"type":["string","null"],"description":"Go to the first page"},"items":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Billing.InvoiceDtoV3"},"description":"List of invoices in the current page."},"last":{"type":["string","null"],"description":"Go to the Last page"},"next":{"type":["string","null"],"description":"Go to the Next page"},"prev":{"type":["string","null"],"description":"Go to the Previous page"}},"description":"Paginated response containing a list of invoices with navigation links for cursor-based pagination.","title":"Billing.InvoiceDtoCursorPagedResponseV3"},"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.InvoiceId.Integer":{"type":"integer","description":"The unique identifier of the invoice whose transactions are to be retrieved.","title":"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.InvoiceId.Integer"},"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.Cursor.String":{"type":"string","description":"Cursor for pagination. Used to retrieve the next set of transaction results.","title":"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.Cursor.String"},"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.PageSize.Integer":{"type":"integer","default":100,"description":"Number of transactions to return per page. Default is 100. Must be between 1 and 1000.","title":"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.PageSize.Integer"},"Billing.TransactionFeeModelV3":{"type":"object","properties":{"fee_list":{"type":["array","null"],"items":{"type":"string"},"description":"Available transaction fee types for billing operations."}},"description":"Response model containing available transaction fee types.","title":"Billing.TransactionFeeModelV3"},"Tracking.Get.Api.V1.Publictracking.Shipments.ShipmentIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int64"},"description":"A list of ShipBob shipment IDs. Must contain between 1 and 25 IDs per request.","title":"Tracking.Get.Api.V1.Publictracking.Shipments.ShipmentIds.IntegerArray"},"TrackingTrackingHistoryItemAddress":{"type":"object","properties":{"city":{"type":["string","null"]},"country":{"type":["string","null"]},"latitude":{"type":["number","null"],"format":"double"},"location":{"type":["string","null"],"description":"A human-readable location string (e.g., 'Los Angeles, CA')."},"longitude":{"type":["number","null"],"format":"double"},"postal_code":{"type":["string","null"]},"state":{"type":["string","null"]}},"description":"The geographic location where this tracking event occurred.","title":"TrackingTrackingHistoryItemAddress"},"Tracking.TrackingHistoryItem":{"type":"object","properties":{"address":{"oneOf":[{"$ref":"#/components/schemas/TrackingTrackingHistoryItemAddress"},{"type":"null"}],"description":"The geographic location where this tracking event occurred."},"status":{"type":["string","null"],"description":"The high-level status at the time of this tracking event."},"substatus":{"type":["string","null"],"description":"A human-readable label for the granular status at the time of this event."},"substatus_code":{"type":["string","null"],"description":"A machine-readable code for the granular status at the time of this event (e.g., 'InTransit_001')."},"substatus_message":{"type":["string","null"],"description":"An optional message providing additional detail about the substatus."},"timestamp":{"type":"string","format":"date-time","description":"The date and time when this tracking event occurred."}},"title":"Tracking.TrackingHistoryItem"},"TrackingShipmentTrackingResponseLastMileCarrier":{"type":"object","properties":{"carrier":{"type":["string","null"],"description":"The name of the last-mile carrier."},"service":{"type":["string","null"],"description":"The service level used by the last-mile carrier."},"tracking_number":{"type":["string","null"],"description":"The tracking number assigned by the last-mile carrier."},"tracking_url":{"type":["string","null"],"description":"A URL to track the shipment on the last-mile carrier's website."}},"description":"Last-mile carrier details. Fields are null when no last-mile carrier is present.","title":"TrackingShipmentTrackingResponseLastMileCarrier"},"Tracking.ShipmentTrackingResponse":{"type":"object","properties":{"carrier":{"type":["string","null"],"description":"The name of the carrier handling the shipment (e.g., UPS, FedEx, USPS, ShipBob)."},"current_status":{"type":"string","description":"The current high-level status of the shipment."},"current_substatus":{"type":["string","null"],"description":"A human-readable label for the current granular status (e.g., 'In Transit')."},"current_substatus_code":{"type":["string","null"],"description":"A machine-readable code for the current granular status (e.g., 'InTransit_001')."},"current_timestamp":{"type":"string","format":"date-time","description":"The date and time of the most recent tracking event."},"delivery_signed_by":{"type":["string","null"],"description":"The name of the person who signed for the delivery, if applicable."},"edd":{"type":["string","null"],"format":"date-time","description":"The estimated delivery date and time."},"edd_source":{"type":["string","null"],"description":"The source of the estimated delivery date. Either 'carrier' (from carrier data) or 'shipbob' (ShipBob estimate)."},"history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Tracking.TrackingHistoryItem"},"description":"A list of historical tracking events for the shipment, ordered newest-first."},"last_mile_carrier":{"$ref":"#/components/schemas/TrackingShipmentTrackingResponseLastMileCarrier","description":"Last-mile carrier details. Fields are null when no last-mile carrier is present."},"proof_of_delivery_urls":{"type":["array","null"],"items":{"type":"string"},"description":"URLs to proof-of-delivery images, if available."},"reference_id":{"type":["string","null"],"description":"Client-defined external unique id of the order from your upstream system."},"service":{"type":["string","null"],"description":"The carrier service level used for the shipment (e.g., Ground, Express)."},"shipment_id":{"type":["integer","null"],"format":"int64","description":"The unique identifier of the shipment in ShipBob's system."},"tracking_number":{"type":"string","description":"The tracking number for the shipment. For ShipBob-carried shipments this is the ShipBob tracking number; for last-mile carrier shipments it is the carrier tracking number."},"tracking_url":{"type":["string","null"],"description":"A publicly accessible URL for tracking the shipment."}},"required":["current_status","current_timestamp","tracking_number"],"title":"Tracking.ShipmentTrackingResponse"},"Tracking.ShipmentTrackingResponseArray":{"type":"array","items":{"$ref":"#/components/schemas/Tracking.ShipmentTrackingResponse"},"title":"Tracking.ShipmentTrackingResponseArray"},"Tracking.Get.Api.V1.Publictracking.Shipments.Bad.Request.String":{"type":"string","title":"Tracking.Get.Api.V1.Publictracking.Shipments.Bad.Request.String"},"Tracking.Get.Api.V1.Publictracking.Shipments.Internal.Server.Error.String":{"type":"string","title":"Tracking.Get.Api.V1.Publictracking.Shipments.Internal.Server.Error.String"},"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.TrackingIds.StringArray":{"type":"array","items":{"type":"string"},"title":"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.TrackingIds.StringArray"},"TrackingPlatformShipmentTrackingResponseLastMileCarrier":{"type":"object","properties":{"carrier":{"type":["string","null"],"description":"The name of the last-mile carrier."},"service":{"type":["string","null"],"description":"The service level used by the last-mile carrier."},"tracking_number":{"type":["string","null"],"description":"The tracking number assigned by the last-mile carrier."},"tracking_url":{"type":["string","null"],"description":"A URL to track the shipment on the last-mile carrier's website."}},"description":"Last-mile carrier details. Fields are null when no last-mile carrier is present.","title":"TrackingPlatformShipmentTrackingResponseLastMileCarrier"},"Tracking.PlatformShipmentTrackingResponse":{"type":"object","properties":{"carrier":{"type":["string","null"],"description":"The name of the carrier handling the shipment (e.g., UPS, FedEx, USPS, ShipBob)."},"current_status":{"type":"string","description":"The current high-level status of the shipment."},"current_substatus":{"type":["string","null"],"description":"A human-readable label for the current granular status (e.g., 'In Transit')."},"current_substatus_code":{"type":["string","null"],"description":"A machine-readable code for the current granular status (e.g., 'InTransit_001')."},"current_timestamp":{"type":"string","format":"date-time","description":"The date and time of the most recent tracking event."},"delivery_signed_by":{"type":["string","null"],"description":"The name of the person who signed for the delivery, if applicable."},"edd":{"type":["string","null"],"format":"date-time","description":"The estimated delivery date and time."},"edd_source":{"type":["string","null"],"description":"The source of the estimated delivery date. Either 'carrier' (from carrier data) or 'shipbob' (ShipBob estimate)."},"history":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Tracking.TrackingHistoryItem"},"description":"A list of historical tracking events for the shipment, ordered newest-first."},"last_mile_carrier":{"$ref":"#/components/schemas/TrackingPlatformShipmentTrackingResponseLastMileCarrier","description":"Last-mile carrier details. Fields are null when no last-mile carrier is present."},"proof_of_delivery_urls":{"type":["array","null"],"items":{"type":"string"},"description":"URLs to proof-of-delivery images, if available."},"reference_id":{"type":["string","null"],"description":"Client-defined external unique id of the order from your upstream system."},"service":{"type":["string","null"],"description":"The carrier service level used for the shipment (e.g., Ground, Express)."},"shipment_id":{"type":["integer","null"],"format":"int64","description":"The unique identifier of the shipment in ShipBob's system."},"tracking_number":{"type":"string","description":"The tracking number for the shipment. For ShipBob-carried shipments this is the ShipBob tracking number; for last-mile carrier shipments it is the carrier tracking number."},"tracking_url":{"type":["string","null"],"description":"A publicly accessible URL for tracking the shipment."}},"required":["current_status","current_timestamp","tracking_number"],"title":"Tracking.PlatformShipmentTrackingResponse"},"Tracking.PlatformShipmentTrackingResponseArray":{"type":"array","items":{"$ref":"#/components/schemas/Tracking.PlatformShipmentTrackingResponse"},"title":"Tracking.PlatformShipmentTrackingResponseArray"},"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Bad.Request.String":{"type":"string","title":"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Bad.Request.String"},"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Internal.Server.Error.String":{"type":"string","title":"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Internal.Server.Error.String"}},"securitySchemes":{"PAT":{"type":"http","scheme":"bearer","description":"Authentication using Personal Access Token (PAT) token"},"OAuth2":{"type":"http","scheme":"bearer","description":"OAuth2 authentication using JWT tokens"}}}}