The following JSON fragment shows the portion of an order JSON that represents shipping groups. In this case the shippingGroup.statusDetail
has been set to SHIPPED
by the calling order management system, indicating that all ordered items (three of the same SKU, commerce item ci10003358) have shipped.
... "shippingGroups": [ { "id": "sg10358", "specialInstructions": {}, "handlingInstructions": [], "trackingNumber": null, "priceInfo": { "amount": 25, "currencyCode": "USD", "amountIsFinal": false, "discounted": false, "rawShipping": 25 }, "shippingGroupClassType": "hardgoodShippingGroup", "description": "sg10358", "commerceItemRelationships": [ { "amount": 0, "id": "r10329", "commerceItemExternalId": null, "relationshipType": "SHIPPINGQUANTITY", "returnedQuantity": 0, "quantity": 3, "commerceItemId": "ci1000358" } ], "submittedDate": null, "actualShipDate": null, "state": "INITIAL", "shipOnDate": null, "shippingMethod": "priorityShippingMethod", "shippingAddress": { "middleName": null, "lastName": "SMITH", "ownerId": null, "state": "CA", "address1": "500 Oracle Drive", "address2": null, "address3": null, "companyName": null, "suffix": null, "country": "US", "city": "Redwood Shores", "faxNumber": null, "postalCode": "94065", "phoneNumber": "5551234567", "email": "email@example.com", "county": null, "prefix": null, "firstName": "JOE", "jobTitle": null }, "stateDetail": SHIPPED } ],
The following sample represents the full order from which the previous shipping groups fragment was taken. Note that the payment group for the order was originally authorized for $58.40. The order can now be settled for this full amount because it included only one shipping group and all the ordered items were shipped in this group. Since this order is now completely shipped, the order state itself can be changed from SUBMITTED
to SHIPPED
.
{ "order": { "lastModifiedTime": 1401739606000, "shippingGroupCount": 1, "paymentGroupCount": 1, "state": "SUBMITTED", "shippingGroups": [ { "id": "sg10358", "specialInstructions": {}, "handlingInstructions": [], "trackingNumber": null, "priceInfo": { "amount": 25, "currencyCode": "USD", "amountIsFinal": false, "discounted": false, "rawShipping": 25 }, "shippingGroupClassType": "hardgoodShippingGroup", "description": "sg10358", "commerceItemRelationships": [ { "amount": 0, "id": "r10329", "commerceItemExternalId": null, "relationshipType": "SHIPPINGQUANTITY", "returnedQuantity": 0, "quantity": 3, "commerceItemId": "ci1000358" } ], "submittedDate": null, "actualShipDate": null, "state": "INITIAL", "shipOnDate": null, "shippingMethod": "priorityShippingMethod", "shippingAddress": { "middleName": null, "lastName": "SMITH", "ownerId": null, "state": "CA", "address1": "500 Oracle Drive", "address2": null, "address3": null, "companyName": null, "suffix": null, "country": "US", "city": "Redwood Shores", "faxNumber": null, "postalCode": "94065", "phoneNumber": "5551234567", "email": "email@example.com", "county": null, "prefix": null, "firstName": "JOE", "jobTitle": null "stateDetail": null } ], "commerceItems": [ { "id": "ci1000358", "productDisplayName": "Striped Button Down Shirt", "returnedQuantity": 0, "priceInfo": { "amount": 29.97, "quantityDiscounted": 0, "discountable": true, "priceListId": "listPrices", "onSale": false, "rawTotalPrice": 29.97, "currencyCode": "USD", "amountIsFinal": false, "listPrice": 9.99, "discounted": false, "currentPriceDetailsSorted": [ { "amount": 29.97, "currencyCode": "USD", "tax": 3.43, "range": { "lowBound": 0, "highBound": 2, "size": 3 }, "amountIsFinal": false, "discounted": false, "quantity": 3, "detailedUnitPrice": 9.99 } ], "salePrice": 0 }, "catalogId": null, "quantity": 3, "catalogRefId": "Sku_3Eii", "externalId": null, "catalogKey": null, "productId": "Product_3Dii" } ], "id": "o10358", "siteId": "siteUS", "priceInfo": { "amount": 29.97, "total": 58.4, "shipping": 25, "currencyCode": "USD", "tax": 3.43, "amountIsFinal": false, "discounted": false, "manualAdjustmentTotal": 0, "rawSubtotal": 29.97, "discountAmount": 0 }, "paymentGroups": [ { "id": "pg10358", "amount": 58.4, "authorizationStatus": [ { "amount": 58.4, "errorMessage": "Request was processed successfully.", "authorizationDecision": "ACCEPT", "transactionId": "4098256070700176195662", "reasonCode": "100", "transactionUuid": "c16865b607e34dbc860b670b0f2b27bb", "transactionSuccess": true, "currency": "USD" } ], "currencyCode": "USD", "token": "9997000128476419", "expirationMonth": "05", "expirationYear": "2016", "paymentGroupClassType": "tokenizedCreditCard", "creditCardNumber": "1111", "submittedDate": "2014-09-04T14:13:28.000Z", "billingAddress": { "middleName": null, "lastName": "SMITH", "ownerId": null, "state": "CA", "address1": "Address Line 1", "address2": null, "address3": null, "companyName": null, "suffix": null, "country": "US", "city": "Redwood Shores", "faxNumber": null, "postalCode": "94065", "phoneNumber": "5551234567", "email": "email@example.com", "county": null, "prefix": null, "firstName": "JOE", "jobTitle": null }, "amountAuthorized": 58.4, "paymentMethod": "tokenizedCreditCard" } ], "taxPriceInfo": { "amount": 3.43, "currencyCode": "USD", "countyTax": 0, "amountIsFinal": false, "countryTax": 0, "discounted": false, "stateTax": 3.43, "cityTax": 0, "districtTax": 0 }, "profileId": "se-570031", "creationTime": 1401739604000, "salesChannel": "default", "relationships": [ { "amount": 58.4, "id": "r10331", "relationshipType": "ORDERAMOUNTREMAINING", "paymentGroupId": "pg10358" } ], "totalCommerceItemCount": 3 } }