Retrieve a specific shipping group for an order
GEThttps://useast.api.elasticpath.com/v2/orders/:orderID/shipping-groups/:shippingGroupID
Retrieve a specific shipping group for an order
Request
Path Parameters
orderID stringrequired
The ID of the order
shippingGroupID stringrequired
The ID of the shipping group
Responses
- 200
- 404
Shipping group details
- application/json
- Schema
- Example (auto)
- Example
Schema
typestring
Possible values: [shipping_group
]
idstring
relationstring
cart_idstring
order_idstring
shipping_typestring
tracking_referencestring
address object
delivery_estimate object
createdAtdate-time
updatedAtdate-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": {
"data": [
{
"type": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
},
"order": {
"data": [
{
"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"
}
}
}
}
{
"data": {
"id": "7cfa5b07-092e-4dbe-bbad-55a771a34117",
"type": "shipping_group",
"relation": "order",
"order_id": "96b1d104-0d2e-41fd-9543-6c3c5a698959",
"shipping_type": "standard",
"tracking_reference": "TRACK123",
"meta": {
"shipping_display_price": {
"total": {
"amount": 1000,
"currency": "USD",
"formatted": "$10.00"
},
"base": {
"amount": 800,
"currency": "USD",
"formatted": "$8.00"
},
"tax": {
"amount": 200,
"currency": "USD",
"formatted": "$2.00"
},
"fees": {
"amount": 0,
"currency": "USD",
"formatted": "$0.00"
}
},
"address": {
"first_name": "John",
"last_name": "Doe",
"phone_number": "(555) 555-1234",
"company_name": "ACME Corp",
"line_1": "123 Main St",
"line_2": "Suite 100",
"city": "Portland",
"postcode": "97201",
"county": "Multnomah",
"country": "US",
"region": "Oregon",
"instructions": "Leave at front door"
},
"delivery_estimate": {
"start": "2024-01-15T00:00:00Z",
"end": "2024-01-20T00:00:00Z"
}
}
}
}
Shipping group or order not found
- application/json
- Schema
- Example (auto)
- order_not_found
- shipping_group_not_found
Schema
detailstring
statusstring
titlestring
[
null
]
{
"errors": [
{
"status": 404,
"title": "Not Found",
"detail": "Order not found"
}
]
}
{
"errors": [
{
"status": 404,
"title": "Group not found",
"detail": "Group with ID [7cfa5b07-092e-4dbe-bbad-55a771a34117] not found for order [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
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/orders/:orderID/shipping-groups/:shippingGroupID");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear