Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wove Shipments API

Shipment management operations

Wove Shipments API is one of 10 APIs that Wove publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 16 paths, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 3 base URLs: https://api.wove.com, https://staging-api.wove.com, http://localhost:4000.

26 operations 16 paths 30 schemas 4 DELETE9 GET7 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.wove.com
https://staging-api.wove.com
http://localhost:4000
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Wove Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained from /auth/token endpoint

Paths & Operations 26

Across 16 paths, the API surfaces 26 operations — 4 DELETE, 9 GET, 7 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Shipments 26

Shipment management operations

GET
/api/v1/external/shipments
List shipments
5 params → 200
POST
/api/v1/external/shipments
Create shipment
body → 201400
GET
/api/v1/external/shipments/{shipmentId}
Get shipment details
1 param → 200404
PUT
/api/v1/external/shipments/{shipmentId}
Update shipment
1 param body → 200404
DELETE
/api/v1/external/shipments/{shipmentId}
Delete shipment
1 param → 204404
GET
/api/v1/external/shipments/{shipmentId}/details
Get detailed shipment information
1 param → 200404
PUT
/api/v1/external/shipments/{shipmentId}/details
Update shipment information
1 param body → 200400404
GET
/api/v1/external/shipments/{shipmentId}/events
Get shipment events
1 param → 200404
GET
/api/v1/external/shipments/{shipmentId}/validation-items
Get validation items
3 params → 200404
PUT
/api/v1/external/shipments/{shipmentId}/validation-items/{itemId}
Update validation item
2 params body → 200400404
POST
/api/v1/external/shipments/{shipmentId}/validation-items/bulk-update
Bulk update validation items
1 param body → 200400404
GET
/api/v1/external/shipments/{shipmentId}/jobs
Get shipment jobs
1 param → 200404
GET
/api/v1/external/shipments/{shipmentId}/containers
List containers
1 param → 200404
POST
/api/v1/external/shipments/{shipmentId}/containers
Create container
1 param body → 201400404
PUT
/api/v1/external/shipments/{shipmentId}/containers/{containerId}
Update container
2 params body → 200400404
DELETE
/api/v1/external/shipments/{shipmentId}/containers/{containerId}
Delete container
2 params → 200404
GET
/api/v1/external/shipments/{shipmentId}/packages
List packages
2 params → 200404
POST
/api/v1/external/shipments/{shipmentId}/packages
Create package
1 param body → 201400404
PUT
/api/v1/external/shipments/{shipmentId}/packages/{packageId}
Update package
2 params body → 200400404
DELETE
/api/v1/external/shipments/{shipmentId}/packages/{packageId}
Delete package
2 params → 200404
POST
/api/v1/external/shipments/{shipmentId}/packages/{packageId}/move
Move package
2 params body → 200400404
GET
/api/v1/external/shipments/{shipmentId}/items
List items
2 params → 200404
POST
/api/v1/external/shipments/{shipmentId}/items
Create item
1 param body → 201400404
PUT
/api/v1/external/shipments/{shipmentId}/items/{itemId}
Update item
2 params body → 200400404
DELETE
/api/v1/external/shipments/{shipmentId}/items/{itemId}
Delete item
2 params → 200404
POST
/api/v1/external/shipments/{shipmentId}/items/{itemId}/move
Move item
2 params body → 200400404

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are ShipmentSummary (18 properties), ShipmentItem (18 properties), ValidationItem (15 properties), CreateItemRequest (15 properties). Each schema is shown below with its type and property counts.

ShipmentSummary
object
18 properties
AddressLocation
object
6 properties
ShipmentPackage
object
13 properties
Address
object
Physical address
6 properties
ShipmentEvent
object
6 properties
AirportLocation
object
3 properties 1 required
ErrorResponse
object
2 properties 2 required
ShipmentContainer
object
8 properties
CreateContainerRequest
object
4 properties 2 required
ValidationItem
object
15 properties
MergeJob
object
9 properties
Location
Carrier
UpdateContainerRequest
object
4 properties
ShipmentCarrier
object
2 properties 2 required
CreateItemRequest
object
15 properties
CreatePackageRequest
object
11 properties
UpdateShipmentRequest
UpdateItemRequest
object
13 properties
PortLocation
object
3 properties 1 required
UpdatePackageRequest
object
10 properties
ReferenceNumber
object
4 properties 3 required
Organization
object
Organization/company information
2 properties 1 required
UpdateShipmentDetailsRequest
object
Request body for updating shipment-level details only. Containers, packages, and items are now managed through separate CRUD endpoints.
1 property
UpdateValidationItemRequest
object
2 properties 1 required
Container
ShipmentItem
object
18 properties
ShipmentDetails
CrossValidationJob
object
9 properties
CreateShipmentRequest
object
14 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wove-shipments-api-openapi.yml Raw ↑

Other APIs Wove publishes across the network.

Wove Authentication API
Wove Documents API
Wove Query Bank API
Wove Rates API
Wove Sources API
Wove Tariffs API
Wove Testing API
Wove TMS Organizations API
Wove Webhooks API