This class provides RESTful services to get and update shipping information in the shopping cart.
com.ibm.commerce.rest.order.handler.ShippingInfoHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/cart/@self/shipping_info | Gets shipping information for the shopping cart. |
PUT | /store/{storeId}/cart/@self/shipping_info | Updates shipping information for the shopping cart. |
Gets shipping information for the shopping cart.
getShippingInfo
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
Updates shipping information for the shopping cart.
updateOrderShippingInfo
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.order.handler.ShippingInfoHandler$UpdateShippingInfoBodyDescription | false | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
404 | The specified resource couldn't be found. |
500 | Internal server error. Additional details will be contained on the server logs. |
PUT /wcs/resources/store/10001/cart/@self/shipping_info?responseFormat=json
{ "addressId": "15808", "orderId": ".", "orderItem": [ { "addressId": "15808" } ], "x_calculationUsage": "-1,-2,-3,-4,-5,-6,-7" }
200
{ "orderId": "25206", "orderItem": [ { "orderItemId": "85205" } ] }
Name | Data Type | Required |
---|---|---|
Order | cart-cartUpdate_item array | false |
Name | Data Type | Required |
---|---|---|
orderItem | cart-cartUpdate_item.orderItem array | false |
userDataField | cart-cartUpdate_item.userDataField array | false |
orderId | string | false |
Name | Data Type | Required |
---|---|---|
UOM | string | false |
userDataField | cart-cartUpdate_item.orderItem.userDataField array | false |
productId | string | false |
itemAttributes | cart-cartUpdate_item.orderItem.itemAttributes array | false |
quantity | string | false |
partNumber | string | true |
orderItemId | string | false |
contractId | string | false |
fulfillmentCenterId | string | false |
fulfillmentCenterName | string | false |
comment | string | false |
Name | Data Type | Required |
---|---|---|
attrValue | string | false |
attrName | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
shipTieCode | string | false |
userDataField | cart-OrderItemShippingInfo.userDataField array | false |
physicalStoreId | string | false |
shippingAddress | string | false |
shippingCarrierAccountNumber | string | false |
shippingChargePolicyID | string | false |
physicalStoreExternalId | string | false |
shippingMode | string | false |
shipInstruction | string | false |
requestedShipDate | string | false |
shipCarrAccntNum | string | false |
shippingChargeType | string | true |
isExpedited | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | cart-OrderShippingInfo.userDataField array | false |
requestedShipDate | string | false |
shipModeId | string | false |
pysicalStoreId | string | false |
addressId | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
orderItem | cart-ShippingInfoOrderItem array | false |
userDataField | cart-shipping_info.userDataField array | false |
shipAsComplete | string | false |
orderId | string | false |
orderShippingInfo | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
organizationUnitName | string | false |
primary | string | false |
personTitle | string | false |
phone1 | string | true |
phone2 | string | true |
mobilePhone1 | string | true |
addressLine | string array | false |
phone1Publish | string | false |
nickName | string | true |
addressType | string | false |
stateOrProvinceName | string | false |
mobilePhone1Country | string | true |
state | string | false |
email1 | string | true |
email2 | string | true |
country | string | false |
attributes | cart-ShippingAddress.attributes array | false |
language | string | false |
postalCode | string | false |
internalOfficeAddress | string | false |
firstName | string | false |
phone1Type | string | false |
phone2Type | string | false |
organizationName | string | false |
personIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType | false |
phone2Publish | string | false |
city | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
fax1 | string | true |
fax2 | string | true |
geographicalTaxCode | string | false |
businessTitle | string | false |
organizationIdentifier | com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType | false |
geographicalShippingCode | string | false |
Name | Data Type | Required |
---|---|---|
attrValue | string | false |
attrKey | string | true |
Name | Data Type | Required |
---|---|---|
userDataField | cart-ShippingInfoOrderItem.userDataField array | false |
orderItemId | string | false |
orderItemShippingInfo | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |
Name | Data Type | Required |
---|---|---|
shipModeLanguage | string | false |
trackingURL | string | false |
language | string | false |
carrier | string | false |
shipModeId | string | false |
description | string | false |
storeId | string | false |
shipModeCode | string | false |
shipModeDescription | string | false |
Name | Data Type | Required |
---|---|---|
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
externalIdentifier | com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier | false |
uniqueID | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
identifier | string | false |
Order update shipping information.
Name | Data Type | Required |
---|---|---|
orderItem | com.ibm.commerce.rest.order.handler.ShippingInfoHandler$UpdateShippingInfoBodyDescription$OrderItemBodyDescription array | true |
shipAsComplete | string | true |
shipModeId | string | true |
addressId | string | false |
x_calculationUsage | string | true |
Order item update shipping information.
Name | Data Type | Required |
---|---|---|
shipInstructions | string | false |
physicalStoreId | string | false |
shipModeId | string | false |
orderItemId | string | true |
addressId | string | false |