Update shipping details for all items in a specific cart

Authentication v1

Identity APIs
User
Address
Auth

User Self Service APIs

Introduction
User Self Service APIs
Authentication APIs

Experiences v2 (XM v2)

XM
Pages
Global Components
Menu

Experiences v1 (XM v1)

XM
Pages
Global Components
Menu

Product Catalog

Product Catalog
Category
Product
Attributes
Bulk Import

Orders v2 (OMS v2)

Order Management System
Order
Order Attribute
Developer Guide
Order Return
Payment Status
Package Tracking
Cross Border
Order Cancellation
Appeasement
Allocation
Configuration
Fraud Configuration
Target Configuration
Location
Location Attribute
Inventory Network
Inventory
Inventory Counter
Inventory Bulk Operation
Inventory Attribute
Inventory Upload Log
Shipment
Shipping Method
Webhook
Notification
Export
Invoice
Fraud
Backorder Preorder Reservation
List

Orders v1 (OMS v1)

Order Management System
Cart
Bill To
Ship To
Wishlist
Cart Decoupled
Warehouse
Inventory
Attributes
List
Tax/Address Validate
Shipping
Payments
Order

Offers v2

Offers
Developer Guide
Promotion
Price Kind
Dynamic Pricing Engine
Segment
Coupon
Coupon Codes
Product
Price List
Attributes
Item
Price Guard
Global Exclusion
Upload Price CSV
Pricing
Redemption
Exports

Offers v1

Offers
Login API
Promotions
Pricing

Subscriptions (SMT API)

Subscriptions API
Cancellation Reasons
Subscription Discounts
Subscriptions
Subscribers
Orders

Loyalty (Member)

Member APIs
Inquire
Discounts
Redeem
Earn
Members

Dropship

Dropship API
Shipments
Products
Invoices
Connections
Inventory
Developer Guide
Returns
Orders

Cart API

Checkout API

Checkout
Checkout

Customer

Core Concepts
Customer Service
Organization
User Party
Organization Group Addresses
User Internal Party
Organization Contracts
Party
Party Contracts
Contracts
User
Search
User Trait
Organization Users
Address
User Address
Trait
Party Address
Party Trait
Organization Group Users
Internal Party
Contract Pricelist
Internal Parties Party
Account
Party Account
Organization Addresses
Organization Groups
Individual Addresses
Users Organization
Individual

PATCH

carts

{cartId}

shipping-details

object

cartId

string

shipToId

string

shipMethod

object

cost

object

amount

number

currency

string

discount

number

shipMethodId

string

shipmentCarrier

string

shipmentMethod

string

address

object

attention

string

street1

string

street2

string

street3

string

street4

string

city

string

state

string

country

string

zipCode

string

kind

string

name

object

first

string

middle

string

last

string

phone

object

number

string

kind

enum<string>

shipToType

string

taxCode

string

isPickup

boolean

altPickupPerson

object

name

object

first

string

middle

string

last

string

phone

object

number

string

kind

enum<string>

string

pickupPerson

object

name

object

first

string

middle

string

last

string

phone

object

number

string

kind

enum<string>

string

warehouseId

string

storeId

string

estimatedShipDate

string

estimatedDeliveryDate

string

shipmentInstructions

string

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

x-api-key

string

API Key for Gateway

Authorization

string

required

Authorization token for the user

Path Parameters

cartId

string

required

ID of cart for which shipping data is being updated

Body

application/json

Shipping details to be updated

cartId

string

required

Cart ID

shipToId

string

Shipping details ID

shipMethod

object

Shipping method and details

address

object

Shipping address

shipToType

string | null

Shipping type

taxCode

string | null

Shipping tax code

isPickup

boolean | null

true: Item is set for pickup<br />false: Item is set for delivery

altPickupPerson

object

Alternative pickup person

pickupPerson

object

Designated pickup person

warehouseId

string | null

Warehouse ID

storeId

string | null

Store ID

estimatedShipDate

string | null

Estimated date for shipping

estimatedDeliveryDate

string | null

Estimated date for delivery

shipmentInstructions

string | null

Store ID

Response

200 - application/json

Shipping response body

shipToId

string | null

Shipping details ID

cartId

string | null

Cart ID

createdAt

string | null

Shipping details creation time

updatedAt

string | null

Last time shipping details were updated

shipMethod

object

Shipping method and details

address

object

Shipping address

shipToType

string | null

Shipping type

taxCode

string | null

Shipping tax code

isPickup

boolean

true: Item is set for pickup<br />false: Item is set for delivery

altPickupPerson

object

Alternative pickup person

pickupPerson

object

Designated pickup person

warehouseId

string | null

Warehouse ID

storeId

string | null

Store ID

estimatedShipDate

string | null

Estimated date for shipping

estimatedDeliveryDate

string | null

Estimated date for delivery

shipmentInstructions

string | null

Store ID

Was this page helpful?

Create shipping details for specific items in specific cart Overview