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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Spree Commerce

Spree Commerce Shipments API

The Shipments API from Spree Commerce — 9 operation(s) for shipments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Spree Commerce Shipments API is one of 183 APIs that Spree Commerce 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 and API documentation.

This API exposes 12 operations across 9 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, http://{defaultHost}.

12 operations 9 paths 9 schemas 1 DELETE2 GET8 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://demo.spreecommerce.org
Authentication
HTTP Bearer
Contact
Vendo Connect Inc.
Resource Areas
1

Authentication & Security 1

Spree Commerce Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth).

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 8 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Shipments 12
GET
/api/v2/platform/shipments
Return a list of Shipments
shipments-list 4 params → 200401
POST
/api/v2/platform/shipments
Create a Shipment
create-shipment 1 param body → 201422
GET
/api/v2/platform/shipments/{id}
Return a Shipment
show-shipment 2 params → 200404401
PATCH
/api/v2/platform/shipments/{id}
Update a Shipment
update-shipment 2 params body → 200422404401
DELETE
/api/v2/platform/shipments/{id}
Delete a Shipment
delete-shipment 1 param → 204404401
PATCH
/api/v2/platform/shipments/{id}/add_item
Adds item (Variant) to an existing Shipment
add-item-shipment 2 params body → 200404401
PATCH
/api/v2/platform/shipments/{id}/remove_item
Removes item (Variant) from Shipment
remove-item-shipment 2 params body → 204200404401
PATCH
/api/v2/platform/shipments/{id}/ready
Mark Shipment as ready to be shipped
ready-shipment 2 params → 200404401
PATCH
/api/v2/platform/shipments/{id}/ship
Mark Shipment as shipped
ship-shipment 2 params → 200404401
PATCH
/api/v2/platform/shipments/{id}/cancel
Cancels the Shipment
cancel-shipment 2 params → 200404401
PATCH
/api/v2/platform/shipments/{id}/resume
Resumes the Shipment
resume-shipment 2 params → 200404401
PATCH
/api/v2/platform/shipments/{id}/pend
Moves Shipment back to pending state
pend-shipment 2 params → 200404401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are resource_properties (4 properties), resources_list (3 properties), validation_errors (2 properties), create_shipment_params (1 property). Each schema is shown below with its type and property counts.

remove_item_shipment_params
object
1 property 1 required
resource_properties
object
4 properties 3 required
add_item_shipment_params
object
1 property 1 required
resources_list
object
3 properties 3 required
create_shipment_params
object
1 property 1 required
validation_errors
object
2 properties 2 required
resource
object
1 property 1 required
error
object
1 property 1 required
update_shipment_params
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-shipments-api-openapi.yml Raw ↑

Other APIs Spree Commerce publishes across the network.

Spree Webhooks
AE Profile APIs.io
@spree/sdk (TypeScript Store API SDK)
AE Profile APIs.io
@spree/admin-sdk (TypeScript Admin API SDK)
AE Profile APIs.io
@spree/cli
AE Profile APIs.io
create-spree-app
AE Profile APIs.io
Spree Next.js Storefront
AE Profile APIs.io
Spree Rails Storefront
AE Profile APIs.io
spree-starter (Application Template)
AE Profile APIs.io
spree-multi-store
AE Profile APIs.io
Spree Stripe Integration
AE Profile APIs.io
Spree Adyen Integration
AE Profile APIs.io
Spree PayPal Checkout Integration
AE Profile APIs.io
#Shipments
← Back to S APIs
API Details
ID
spree-commerce:spree-commerce-shipments-api
Base URL
https://demo.spreecommerce.org
Docs
https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
Provider
Spree Commerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=spree-commerce-shipments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/spree-commerce-shipments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Spree Commerce Shipments 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.