1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Store
  4. Orders
  5. Current
  6. Shipping Groups

Manage shipping groups relationship to cart items

post

/ccstore/v1/orders/current/shippingGroups/relateToItems

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.

Manage shipping group(s) relationships to cart item(s). Can be used to redefine which items are assigned to which shipping groups and the quantity assigned. Will modify existing relationships or create new ones as the assignment requires. Relationships that release existing item assignment must be placed before relationships that reassign the items, as the overall item quantity cannot be exceeded only reassigned.

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).

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : relateToItems_request
Type: object
Show Source
Example:
{
    "relationships":[
        {
            "commerceItemId":"ci12000411",
            "quantity":1,
            "shippingGroupId":"sg130411"
        },
        {
            "commerceItemId":"ci12000411",
            "quantity":2,
            "shippingGroupId":"sg130412"
        }
    ]
}
Nested Schema : items
Type: array
The Relationships to be applied between Shipping Groups and Commerce Items.
Show Source
Nested Schema : items
Type: object
Show Source
  • The available date (in ISO format) for collection of items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
  • The ID of the Commerce Item in the relationship to be created, modified or removed.
  • The preferred date (in ISO format) for the items to be picked up in store (if shipping group type is inStorePickupShippingGroup).
  • The quantity of the Commerce Item to be applied to the relationship. If a quantity of 0 is provided this will remove the relationship. If a quantity of -1 is provided this will create a remaining relationship that any unallocated quantities will be added to.
  • The ID of the Shipping Group in the relationship to be created, modified or removed.
Back to Top

Response

Supported Media Types

200 Response

The model being returned when the POST operation succeeds. It contains a list of Shipping Groups and an Order representation.
Body ()
Root Schema : shippingGroupsCollectionWithEmbeddedOrder_response
List of the Shipping Groups with embedded Order.
Match All
Show Source
Example:
{
    "totalResults":"4",
    "offset":"0",
    "hasMore":"false",
    "limit":"250",
    "links":[
        {
            "method":"GET",
            "rel":"last",
            "href":"http://localhost:8080/ccstoreui/v1/orders/currents"
        }
    ],
    "items":[
        {
            "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":{
                "secondaryCurrencyTaxAmount":0,
                "shippingTax":0,
                "cost":0,
                "taxIncluded":true,
                "taxCode":"TAXCODE1",
                "value":"ground",
                "shippingMethodDescription":"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"
        }
    ],
    "embedded":{
        "order":{
            "shippingGroups":{
                "priceInfo":{
                    "amount":179,
                    "total":204.06,
                    "shipping":6.5,
                    "primaryCurrencyTotal":204.06,
                    "shippingSurchargeValue":0,
                    "tax":18.56,
                    "subTotal":179,
                    "currencyCode":"USD",
                    "totalWithoutTax":185.5
                },
                "discountInfo":{
                    "orderDiscount":0,
                    "shippingDiscount":0,
                    "discountDescList":[
                        {
                            "promotionName":"Free Tattoo",
                            "external":false,
                            "promotionLevel":"item",
                            "coupon":"FREETATTOO",
                            "promotionDesc":"Explicit Item Discount - FREETATTOO",
                            "promotionId":"explicitItemFreeDiscount"
                        }
                    ],
                    "orderImplicitDiscountList":[
                        {
                            "external":false,
                            "promotionLevel":"item",
                            "promotionDesc":"Implicit Item Discount - 3PercentOff",
                            "promotionId":"implicitItemPercentDiscount"
                        }
                    ]
                },
                "shippingMethod":{
                    "shippingTax":0.46,
                    "cost":6.5,
                    "taxIncluded":true,
                    "taxCode":"PC00300",
                    "value":"ground",
                    "shippingMethodDescription":"Ground"
                },
                "shippingGroupId":"sg10032",
                "shippingAddress":{
                    "lastName":"Smith",
                    "country":"US",
                    "address3":"Florida",
                    "address2":"Florida",
                    "city":"Orlando",
                    "prefix":"Mr",
                    "address1":"76 Palm Drive",
                    "postalCode":32002,
                    "jobTitle":"Doctor",
                    "companyName":"Doctor's Place",
                    "county":"Florida",
                    "suffix":"John Smith",
                    "selectedCountry":"US",
                    "firstName":"John",
                    "phoneNumber":"09345456345",
                    "alias":"Address03#",
                    "faxNumber":330193316,
                    "middleName":"Joe",
                    "state":"FL",
                    "email":"john@email.com"
                },
                "type":"hardgoodShippingGroup",
                "items":[
                    {
                        "availablePickupDate":"2020-06-30",
                        "inventoryLocationId":"SiteUS-GlenAllen187",
                        "rawTotalPrice":29.99,
                        "returnedQuantity":0,
                        "dynamicProperties":[
                            {
                                "id":"dynamicPropertyMode",
                                "label":"Mode",
                                "value":"pickup"
                            }
                        ],
                        "shippingSurchargeValue":0,
                        "availabilityDate":"2020-06-30",
                        "discountAmount":0,
                        "preOrderQuantity":0,
                        "commerceItemId":"ci3000411",
                        "variant":[
                            {
                                "optionValue":"red",
                                "optionName":"color"
                            }
                        ],
                        "onSale":false,
                        "state":"SUBMITTED",
                        "unitPrice":29.99,
                        "quantity":5,
                        "pointOfNoRevision":false,
                        "relationshipType":"string",
                        "productId":"Product_18Cxi",
                        "salePrice":0,
                        "preferredPickupDate":"2020-06-30",
                        "catRefId":"Sku_18Cxi",
                        "skuProperties":[
                            {
                                "propertyType":"sku-base",
                                "name":"UPC Code",
                                "id":"upcCode",
                                "value":12345
                            }
                        ],
                        "siteId":"siteUS",
                        "asset":false,
                        "backOrderQuantity":0
                    }
                ]
            },
            "orderId":"o10003",
            "creationSiteId":"siteUS",
            "dynamicProperties":[
                {
                    "id":"giftWrapMessage123",
                    "label":"Gift Wrap Message123",
                    "value":"newGSMessage45600"
                }
            ],
            "payments":[
                {
                    "paymentGroupId":"pg70048",
                    "savedCardId":"sc1234",
                    "amount":170,
                    "balance":100,
                    "gatewayName":"chaseGiftCard",
                    "giftCardNumber":6.0483478347347343E18,
                    "paymentMethod":"creditCard",
                    "uiIntervention":null,
                    "isAmountRemaining":true,
                    "paymentState":"INITIAL",
                    "maskedCardNumber":"xxxxxxxxxxxxxxxxxx1234"
                }
            ],
            "shippingMethod":{
                "shippingTax":0.46,
                "cost":6.5,
                "value":"ground"
            },
            "shoppingCart":{
                "numberOfItems":1,
                "items":[
                    {
                        "primaryThumbImageURL":"ccstore/v1/images/?source=/file/v7023553219093550939/products/Book.jpg&height=100&width=100",
                        "rawTotalPrice":179,
                        "displayName":"Dora The Explorer",
                        "dynamicProperties":[
                            {
                                "id":"giftWrapMessage123",
                                "label":"Gift Wrap Message123",
                                "value":"newGSMessage45600"
                            }
                        ],
                        "shippingSurchargeValue":0,
                        "discountAmount":0,
                        "externalData":[
                            {
                                "values":{
                                    "dynamic_property_key":"string"
                                },
                                "name":"string",
                                "actionCode":"string"
                            }
                        ],
                        "isItemValid":true,
                        "commerceItemId":"ci3000411",
                        "price":21.99,
                        "variant":[
                            {
                                "optionValue":"red",
                                "optionName":"color"
                            }
                        ],
                        "primaryImageAltText":"Dora The Explorer",
                        "actionCode":"Add",
                        "state":"SUBMITTED",
                        "id":"ci3000415",
                        "primaryImageTitle":"Dora The Explorer",
                        "childSKUs":[
                            {
                                "primaryThumbImageURL":null
                            }
                        ],
                        "quantity":5,
                        "productId":"Product_18Cxi",
                        "pointOfNoRevision":true,
                        "giftWithPurchaseCommerceItemMarkers":[
                            {
                                "remainingQuantity":0,
                                "selectedQuantity":0,
                                "data":"-123345466",
                                "automaticQuantity":0,
                                "value":"promo10002",
                                "targetedQuantity":0,
                                "key":"atg.gwp"
                            }
                        ],
                        "originalCommerceItemId":"ci3000411",
                        "catRefId":"Sku_18Cxi",
                        "skuProperties":[
                            {
                                "propertyType":"sku-base",
                                "name":"name",
                                "id":"displayName",
                                "value":"Sku_18Cxi"
                            }
                        ],
                        "route":"/dora-the-explorer/product/Sku_18Cxi",
                        "siteId":"siteUS",
                        "shopperInput":{
                            "additionalProp1":"string",
                            "additionalProp3":"string",
                            "additionalProp2":"string"
                        },
                        "asset":false
                    }
                ]
            },
            "giftWithPurchaseInfo":[
                {
                    "giftWithPurchaseQuantityAvailableForSelection":1,
                    "giftWithPurchaseType":1,
                    "giftWithPurchaseDetail":"Product_6Dxyi",
                    "promotionId":"promo40001",
                    "giftWithPurchaseIdentifier":-2.3234234355E10
                }
            ],
            "priceListGroup":{
                "deleted":false,
                "isTaxIncluded":false,
                "endDate":null,
                "displayName":"Default Price Group",
                "repositoryId":"defaultPriceGroup",
                "active":true,
                "currency":{
                    "symbol":"$",
                    "displayName":"US Dollar",
                    "repositoryId":"currency",
                    "fractionalDigits":2,
                    "currencyCode":"USD",
                    "numericCode":840
                },
                "locale":"en_US",
                "shippingSurchargePriceList":{
                    "repositoryId":"shippingSurchargePrices"
                }
            },
            "siteId":"siteUS",
            "giftWithPurchaseOrderMarkers":[
                {
                    "quantity":1,
                    "selectedQuantity":0,
                    "removedQuantity":1,
                    "data":-2.4564678912E10,
                    "autoRemove":true,
                    "giftDetail":"Product_6Dxyi",
                    "automaticQuantity":0,
                    "giftType":"product",
                    "failedQuantity":0,
                    "value":"promo40001",
                    "targetedQuantity":0,
                    "key":"atg.gwp"
                }
            ],
            "orderAction":"order"
        }
    }
}
Nested Schema : model_collectionPagination
Type: object
Pagination details.
Show Source
Nested Schema : shippingGroupsCollectionWithEmbeddedOrder_response-allOf[1]
Type: object
Show Source
Nested Schema : embedded
Type: object
Placeholder for additional information
Show Source
Nested Schema : items
Type: array
Shipping group information for order. Note the shippng groups will be one type hardgoodShippingGroup and/or instorePickUpShippingGroup.
Show Source
Nested Schema : model_order
Type: object
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
giftWithPurchaseOrderMarker information.
Show Source
Nested Schema : payments
Type: array
Payment details for the order, including additional properties specific to the payment type.
Show Source
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : shippingGroups
Type: object
The shipping groups in the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping Method information of the order.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
The currency object.
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Shipping Surcharge PriceList object.
Show Source
Nested Schema : discountInfo
Type: object
Discount Information
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : discountDescList
Type: array
The list of all the order discounts.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
Implicit Promotions for the order
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childSkus
Type: array
An array with single primary image url for this item's sku, or its default image.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
giftWithPurchaseCommerceItemMarker information.
Show Source
Nested Schema : itemDiscountInfos
Type: array
Item discount infos
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : couponCodes
Type: array
Coupon codes applied to the items
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : model_hardgoodShippingGroup
Hardgood shipping group.
Match All
Show Source
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
Nested Schema : model_hardgoodShippingGroup-allOf[1]
Type: object
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address. Note the shipping address can contain dynamic properties.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking information for shipping group.
Show Source
Nested Schema : items
Type: object
Show Source

400 Response

The error response (which alternates to the default response depending on error reason).
Body ()
Root Schema : errorModelSingleError
Type: object
Show Source

Default Response

The error response.
Body ()
Root Schema : errorModelMultiErrors
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top