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

ShipBob subpackage_returns API

The subpackage_returns API from ShipBob — 3 operation(s) for subpackage_returns.

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

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

This API exposes 5 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

5 operations 3 paths 21 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

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

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

subpackage_returns 5
POST
/2026-01/return
Create Return Order
create-return-order 2 params body → 201400401403422
GET
/2026-01/return
Get Return Orders
get-return-orders 20 params → 200400401403404
GET
/2026-01/return/{id}
Get Return Order
get-return-order 3 params → 200400401403404
PUT
/2026-01/return/{id}
Edit Return Order
edit-return-order 2 params body → 200401403404422
POST
/2026-01/return/{id}:cancel
Cancel Return order
cancel-return-order 2 params → 200400401403

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Returns.PublicReturnDto (21 properties), Returns.PublicReturnV1Dto (15 properties), Returns.InventoryItemDto (8 properties), Returns.PublicReturnDtoPagedUrlResultDto (5 properties). Each schema is shown below with its type and property counts.

Returns.PublicReturnDtoPagedUrlResultDto
object
5 properties
Returns.InvoiceDto
object
The invoice amount and curency
2 properties
Returns.FulfillmentCenterDto
object
The details of a Fulfillment Center
2 properties
Returns.LotInformationDto
object
Lot information associated with a specific inventory item.
3 properties
Returns.InventoryItemV1Dto
object
The details of the inventory in the return order
5 properties
Returns.ReturnInventory
object
An inventory being returned, includes the quantity and an override for the return action.
5 properties 3 required
Returns_cancelReturnOrder_Response_200
object
Empty response body
Returns.PublicReturnV1Dto
object
The details of a public return order (V1), including the transactions and inventory items
15 properties
Returns.ApiError
object
4 properties
Returns.InventoryItemDto
object
The details of the inventory in the return order
8 properties
Returns.ReturnAction
string
Returns.PublicReturnDto
object
The details of a public return order, including the transactions and inventory items
21 properties
Returns.ChannelDto
object
The details of a Channel
2 properties
Returns.StatusHistoryDto
object
Status history
2 properties
Returns.ActionRequestedDto
object
The details of the action requested for inventory
3 properties
202601ReturnGetParametersSortOrder
string
Returns.ActionTakenDto
object
The details of an action taken for inventory item in the return
4 properties
Returns.Facility
object
A Facility to process Returns.
2 properties 1 required
Returns.CreateReturnRequest
object
The request payload for creating a Return of inventory.
5 properties 3 required
Returns.TransactionDto
object
The details of a transaction charged to the return order
2 properties
Returns.ProblemDetails
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs ShipBob publishes across the network.

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

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

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

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

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