Sitecore OrderCloud Documentation

docs

Portal login

Shipments

A Shipment is a grouping of one or more Line Items from one or more Orders that is physically packaged and delivered to the Buyer as a single unit. It is typically created by the Marketplace Owner after the Order is submitted as part of the fulfillment process.

Shipments.List

Get a list of shipments.

get

v1/shipments

Shipments.Create

Create a new shipment.

post

v1/shipments

Shipments.Get

Get a single shipment.

get

v1/shipments/{shipmentID}

Shipments.Save

Create or update a shipment.

put

v1/shipments/{shipmentID}

Shipments.Delete

Delete a shipment.

delete

v1/shipments/{shipmentID}

Shipments.Patch

Partially update a shipment.

patch

v1/shipments/{shipmentID}

Shipments.ListItems

Get a list of shipment items.

get

v1/shipments/{shipmentID}/items

Shipments.SaveItem

Create or update a shipment item.

post

v1/shipments/{shipmentID}/items

Shipments.GetItem

Get a single shipment item.

get

v1/shipments/{shipmentID}/items/{orderID}/{lineItemID}

Shipments.DeleteItem

Delete a shipment item.

delete

v1/shipments/{shipmentID}/items/{orderID}/{lineItemID}

Shipments.SetShipFromAddress

Set a ship from address.

put

v1/shipments/{shipmentID}/shipfrom

Shipments.SetShipToAddress

Set a ship to address.

put

v1/shipments/{shipmentID}/shipto

Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore