Skip to main content

Spree Commerce Guides home page

Support
Get started
Get started

Community
Showcase
Github
Blog

API basics

Introduction
Pagination
Filtering and sorting
Fetching multiple resources

Storefront API

Authentication

Platform API

Authentication
- GET
  Return a list of Shipments
- POST
  Create a Shipment
- GET
  Return a Shipment
- DEL
  Delete a Shipment
- PATCH
  Update a Shipment
- PATCH
  Adds item (Variant) to an existing Shipment
- PATCH
  Removes item (Variant) from Shipment
- PATCH
  Mark Shipment as ready to be shipped
- PATCH
  Mark Shipment as shipped
- PATCH
  Cancels the Shipment
- PATCH
  Resumes the Shipment
- PATCH
  Moves Shipment back to pending state

Shipments

Removes item (Variant) from Shipment

If selected Variant is removed completely and Shipment doesn’t include any other Line Items, Shipment itself will be deleted

Was this page helpful?

Suggest edits Raise issue

Adds item (Variant) to an existing Shipment Mark Shipment as ready to be shipped