Update a shipping group for a cart
PUThttps://useast.api.elasticpath.com/v2/carts/:cartId/shipping-groups/:shippingGroupId
Update a specific shipping group for a cart
Request
Path Parameters
cartId stringrequired
The ID of the cart
shippingGroupId stringrequired
The ID of the shipping group
Bodyrequired
data object
Responses
- 200
- 400
- 404
Shipping group updated successfully
Schema
typestring
Possible values: [shipping_group
]
idstring
relationstring
cart_idstring
order_idstring
shipping_typestring
tracking_referencestring
address object
delivery_estimate object
createdAtstring<date-time>
updatedAtstring<date-time>
relationships object
discounts object[]
meta object
{
"type": "shipping_group",
"id": "string",
"relation": "string",
"cart_id": "string",
"order_id": "string",
"shipping_type": "string",
"tracking_reference": "string",
"address": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"company_name": "string",
"line_1": "string",
"line_2": "string",
"city": "string",
"postcode": "string",
"county": "string",
"country": "string",
"region": "string",
"instructions": "string"
},
"delivery_estimate": {
"start": "2024-07-29T15:51:28.071Z",
"end": "2024-07-29T15:51:28.071Z"
},
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z",
"relationships": {
"cart": {
"type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"order": {
"type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
},
"discounts": [
{
"amount": {
"amount": 0,
"currency": "string",
"includes_tax": true
},
"code": "string",
"id": "string",
"promotion_source": "string",
"is_cart_discount": true,
"ordinal": 0
}
],
"meta": {
"shipping_display_price": {
"total": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"base": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"fees": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"discount": {
"amount": 0,
"currency": "string",
"formatted": "string"
}
},
"total_display_price": {
"with_tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"without_tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"tax": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"discount": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"balance_owing": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"paid": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"authorized": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"without_discount": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"shipping": {
"amount": 0,
"currency": "string",
"formatted": "string"
},
"shipping_discount": {
"amount": 0,
"currency": "string",
"formatted": "string"
}
}
}
}
Invalid request
Schema
errors object[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string",
"meta": {
"id": "string",
"ids": [
"string"
],
"item_ids": [
"string"
],
"shipping_group_id": "string",
"shipping_group_ids": [
"string"
],
"cart_id": "string",
"code": "string",
"order_id": "string",
"value": "string"
}
}
]
}
{
"errors": [
{
"status": 400,
"title": "Cart Currency Mismatch",
"detail": "The existing shipping group uses USD, cannot update shipping group with currency EUR"
}
]
}
Shipping group or cart not found
Schema
errors object[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string",
"meta": {
"id": "string",
"ids": [
"string"
],
"item_ids": [
"string"
],
"shipping_group_id": "string",
"shipping_group_ids": [
"string"
],
"cart_id": "string",
"code": "string",
"order_id": "string",
"value": "string"
}
}
]
}
{
"errors": [
{
"status": 404,
"title": "Cart shipping group not found",
"detail": "Cart shipping group with ID [7cfa5b07-092e-4dbe-bbad-55a771a34117] not found for cart [abc123]"
}
]
}
Authorization: http
name: bearerAuthtype: httpscheme: bearer
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
ResponseClear