Get a shipping group by ID
get
/ccstore/v1/orders/current/shippingGroups/{id}
This API is used by the CX Commerce OSF Storefront. This API is currently not used by CX Commerce Classic Storefront but may be used in the future. It may be used in applications outside of CX Commerce Storefront.
Get shipping group details from the cart for the given shipping group ID.
This endpoint is part of a group of APIs used in conjunction with each other to perform granular actions on the cart (current incomplete order).
The X-CCVisitorId must be used if accessing shipping group before any items have been added to the cart.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the shipping group to retrieve.
Query Parameters
-
filterKey(optional): string
Specifies the predefined filter key ID that can be used to filter the shipping group data in the response.'shippingGroupData' is the currently available filter key for this and the pre configured values to be filtered with can be modified via CCM.
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
-
X-CCVisitorId(optional): string
ID provided by the Oracle Commerce Visit Service to uniquely identify the current visitor. It is required for every request to enable full endpoint capabilities for all shopper types.
Response
Supported Media Types
- application/json
200 Response
The model being returned when the GET operation succeeds. It contains the details of the shipping group in the current order for the given shipping group ID.
Root Schema : model_hardgoodShippingGroup
Hardgood shipping group.
Match All
Show Source
-
object
model_shippingGroup
Discriminator:
shippingGroupClassType
Base shipping group. -
object
model_hardgoodShippingGroup-allOf[1]
Example:
{
"priceInfo":{
"amount":179,
"total":204.06,
"lkpValExcludingFreeShip":204.06,
"shipping":6.5,
"shippingSurchargeValue":0,
"tax":18.56,
"subTotal":179,
"currencyCode":"USD",
"totalWithoutTax":185.5
},
"discountInfo":{
"orderDiscount":44.67,
"shippingDiscount":22.99,
"discountDescList":[
{
}
]
},
"shipOnDate":"2019-12-04T10:40:17.794Z",
"actualShipDate":"2019-12-04T10:40:17.794Z",
"trackingInfo":[
{
"trackingUrl":"tracking.url",
"trackingNumber":"TRN000001"
}
],
"shippingMethod":{
"value":"ground"
},
"shippingGroupId":"SG0000001",
"shippingAddress":{
"firstName":"Wilson",
"lastName":"Anderson",
"phoneNumber":"098233456764",
"address1":"Main Street",
"postCode":"01887",
"state":"MA",
"email":"wilson.anderson@example.com"
},
"type":"hardgoodShippingGroup",
"submittedDate":"2019-12-04T10:40:17.794Z",
"items":[
{
"availablePickupDate":"string",
"primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v7023553219093550939/products/Samsung_F90BN_LARGE.jpg&height=100&width=100",
"inventoryLocationId":"location001",
"rawTotalPrice":699.99,
"dynamicProperties":[
{
"id":"DYNPROP001",
"label":"Dynamic property label",
"value":"Dynamic property value"
}
],
"displayName":"Samsung - F90BN HD Flash Memory Camcorder",
"shippingSurchargeValue":0,
"availabilityDate":"2019-12-04T10:40:17.794Z",
"discountAmount":0,
"externalData":[
{
"values":{
"dynamic_property_key":"property_key_1"
},
"name":"property name",
"actionCode":"action_code"
}
],
"preOrderQuantity":0,
"variant":[
{
"optionValue":"Neon",
"optionName":"color"
}
],
"onSale":true,
"primaryImageAltText":"Samsung - F90BN HD Flash Memory Camcorder",
"unitPrice":597,
"primaryImageTitle":"Samsung - F90BN HD Flash Memory Camcorder",
"quantity":1,
"pointOfNoRevision":false,
"productId":"camcorder_1",
"salePrice":597,
"detailedItemPriceInfo":[
{
"discounted":true,
"amount":597,
"quantity":1,
"tax":0,
"orderDiscountShare":0,
"detailedUnitPrice":597,
"currencyCode":"USD"
}
],
"preferredPickupDate":"2019-12-04T10:40:17.794Z",
"active":true,
"catRefId":"camcordersku_1_3",
"skuProperties":[
{
"propertyType":"sku-base",
"name":"Not Returnable",
"id":"nonreturnable",
"value":false
}
],
"route":"/samsung-f90bn-hd-flash-memory-camcorder/product/camcorder_1",
"siteId":"siteUS",
"backOrderQuantity":0,
"listPrice":699.99,
"status":"INITIAL"
}
],
"shippingGroupClassType":"hardgoodShippingGroup"
}
Nested Schema : model_shippingGroup
Type:
object
Discriminator:
shippingGroupClassType
Base shipping group.
Show Source
-
actualShipDate(optional):
string(datetime)
Actual date items where shipped.Example:
2019-12-04T10:40:17.794Z
-
discountInfo(optional):
object discountInfo
Shipping group discount information.
-
items(optional):
array items
List of items related to the shipping group.
-
priceInfo(optional):
object priceInfo
Price information of the shipping group.
-
shipOnDate(optional):
string(datetime)
Date items are to be shipped.Example:
2019-12-04T10:40:17.794Z
-
shippingGroupClassType:
string
Example:
hardgoodShippingGroup
-
shippingGroupId(optional):
string
Shipping group ID.Example:
SG0000001
-
shippingMethod(optional):
object model_shippingMethod
The shipping method details for the shipping group.
-
submittedDate(optional):
string(datetime)
Shipping group submitted date.Example:
2019-12-04T10:40:17.794Z
-
type(optional):
string
The shipping group type.Example:
hardgoodShippingGroup
Nested Schema : model_hardgoodShippingGroup-allOf[1]
Type:
Show Source
object
-
shippingAddress(optional):
object shippingAddress
Shipping address. Note the shipping address can contain dynamic properties.
-
trackingInfo(optional):
array trackingInfo
Tracking information for shipping group.
Nested Schema : shippingAddress
Type:
object
Shipping address. Note the shipping address can contain dynamic properties.
Show Source
-
address1(optional):
string
The address line one (required POST).Example:
Main Street
-
country(optional):
The address country.
-
email(optional):
string
The contact email address.Example:
wilson.anderson@example.com
-
firstName(optional):
string
The contact's first name (required POST).Example:
Wilson
-
lastName(optional):
string
The contact's last name (required POST).Example:
Anderson
-
phoneNumber(optional):
string
Pattern:
[0-9()+ -]+$
The contact phone number (optional POST|PATCH).Example:098233456764
-
postCode(optional):
string
The addess postcode (required POST, optional PATCH).Example:
01887
-
state(optional):
string
The address state (required POST, optional PATCH).Example:
MA
Nested Schema : items
Type:
Show Source
object
-
trackingNumber(optional):
string
Tracking numberExample:
TRN000001
-
trackingUrl(optional):
string
Tracking URL for shipping group.Example:
tracking.url
400 Response
The error response (which alternates to the default response depending on error reason).
Root Schema : errorModelSingleError
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
Default Response
The error response.
Root Schema : errorModelMultiErrors
Type:
Show Source
object
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
status(optional):
string
The HTTP status code
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code