checkout_profile

This class provides RESTful services to get and update a checkout profile.

Handler Class:

com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler

Method Summary

HTTP Method	Path	Description
GET	/store/{storeId}/person/@self/checkoutProfile	Gets the Check Out Profile for the logged in user using the Member service. The shopper must log in before invoking this method.
PUT	/store/{storeId}/person/@self/checkoutProfile	Updates the CheckOutProfile for the logged in user using the Member service. The shopper must log in before invoking this method.

Method Details

GET /store/{storeId}/person/@self/checkoutProfile

Gets the Check Out Profile for the logged in user using the Member service. The shopper must log in before invoking this method.

Handler Method:

getCheckoutProfile

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A

HTTP Status Codes:

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.

Response Data Type:

person-checkoutProfile

PUT /store/{storeId}/person/@self/checkoutProfile

Updates the CheckOutProfile for the logged in user using the Member service. The shopper must log in before invoking this method.

Handler Method:

updateCheckoutProfile

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
body	Update checkout profile body.	body	person-checkoutProfile	false	N/A

HTTP Status Codes:

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.

Response Data Type:

com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler$UserIdContainer

Example

Request:

PUT /wcs/resources/store/10001/person/@self/checkoutProfile?responseFormat=json

Body:

{
	"SameShippingAndBillingAddress": "on",
	"URL": "AjaxLogonForm",
	"account": "4111111111111111",
	"billing_addressLine": [
		"123 Main St",
		""
	],
	"billing_addressType": "Billing",
	"billing_city": "Toronto",
	"billing_country": "CA",
	"billing_email1": "john@example.com",
	"billing_firstName": "John",
	"billing_lastName": "Smith",
	"billing_nickName": "Default_Billing_10001",
	"billing_phone1": "",
	"billing_state": "ON",
	"billing_zipCode": "M1M1M1",
	"curr_date": "24",
	"curr_month": "11",
	"curr_year": "2014",
	"pay_account": "4111111111111111",
	"pay_cc_brand": "VISA",
	"pay_expire_month": "11",
	"pay_expire_year": "2014",
	"pay_payMethodId": "VISA",
	"pay_payment_method": "VISA",
	"shipping_addressLine": [
		"123 Main St",
		""
	],
	"shipping_addressType": "Shipping",
	"shipping_city": "Toronto",
	"shipping_country": "CA",
	"shipping_email1": "john@example.com",
	"shipping_firstName": "John",
	"shipping_lastName": "Smith",
	"shipping_modeId": "10054",
	"shipping_nickName": "Default_Shipping_10001",
	"shipping_phone1": "",
	"shipping_state": "ON",
	"shipping_zipCode": "M1M1M1"
}

HTTP Status Code:

200

Response:

{
	"userId": "11051"
}

Data Type Details

com.ibm.commerce.foundation.common.datatypes.DescriptionType

Properties:

Name	Data Type	Required
value	string	false
language	string	false

com.ibm.commerce.foundation.common.datatypes.ExternalShipModeIdentifier

Properties:

Name	Data Type	Required
carrier	string	false
shipModeCode	string	false
storeUniqueID	string	false

com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType

Properties:

Name	Data Type	Required
uniqueID	string	false
distinguishedName	string	false

com.ibm.commerce.foundation.common.datatypes.PaymentMethodType

Properties:

Name	Data Type	Required
paymentMethodName	string	false
userData	com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData	false
description	com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.description	false

com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.description

Properties:

Name	Data Type	Required
value	string	false
language	string	false

com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData

Properties:

Name	Data Type	Required
userDataField	com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData.userDataField array	false

com.ibm.commerce.foundation.common.datatypes.PaymentMethodType.userData.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType

Properties:

Name	Data Type	Required
externalIdentifier	com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier	false
uniqueID	string	false
distinguishedName	string	false

com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier

Properties:

Name	Data Type	Required
identifier	string	false

com.ibm.commerce.rest.member.handler.PersonCheckoutProfileHandler$UserIdContainer

User identification container.

Properties:

Name	Data Type	Required
userId	string	true

java.util.Map$Entry

Properties:

Name	Data Type	Required
value	string	false
key	string	true

person-checkoutProfile

Properties:

Name	Data Type	Required
CheckoutProfile	person-checkoutProfile.CheckoutProfile array	false
userId	string	false

person-checkoutProfile.CheckoutProfile

Properties:

Name	Data Type	Required
billing_organizationIdentifier	com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType	false
shipping_mobilePhone1Country	string	true
billing_middleName	string	false
billing_lastName	string	false
shipping_country	string	false
shipping_externalIdentifier	com.ibm.commerce.foundation.common.datatypes.ExternalShipModeIdentifier	false
paymentMethod	com.ibm.commerce.foundation.common.datatypes.PaymentMethodType	false
billing_mobilePhone1	string	true
shipping_firstName	string	false
shipping_internalOfficeAddress	string	false
billing_addressType	string	false
billing_shippingGeoCode	string	false
shipping_phone1Type	string	false
shipping_phone2Type	string	false
billing_internalOfficeAddress	string	false
billing_firstName	string	false
billing_attributes	java.util.Map$Entry array	false
billing_language	string	false
shipping_bestCallingTime	string	false
shipping_zipCode	string	false
shipping_publishPhone1	string	false
billing_phone1Type	string	false
billing_personIdentifier	com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType	false
shipping_publishPhone2	string	false
billing_organizationName	string	false
billing_phone2Type	string	false
shipping_fax1	string	true
shipping_fax2	string	true
shipping_businessTitle	string	false
billing_phone2Publish	string	false
billing_city	string	false
shipping_lastName	string	false
billing_businessTitle	string	false
shipping_phone1	string	true
shipping_phone2	string	true
shipping_mobilePhone1	string	true
shipping_addressType	string	false
billing_primary	string	false
shipping_shippingGeoCode	string	false
billing_personTitle	string	false
shipping_state	string	false
billing_addressLine	string array	false
shipping_email1	string	true
billing_organizationUnitName	string	false
shipping_email2	string	true
billing_phone1	string	true
billing_phone1Publish	string	false
billing_phone2	string	true
shipping_language	string	false
shipping_attribute	java.util.Map$Entry array	false
billing_mobilePhone1Country	string	true
billing_state	string	false
shipping_modeId	string	false
shipping_organizationName	string	false
shipping_personIdentifier	com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType	false
billing_country	string	false
billing_nickName	string	true
billing_email1	string	true
billing_email2	string	true
shipping_city	string	false
shipping_addressId	string	false
protocolData	person-checkoutProfile.CheckoutProfile.protocolData array	false
shipping_taxGeoCode	string	false
userDataField	person-checkoutProfile.CheckoutProfile.userDataField array	false
billing_bestCallingTime	string	false
billing_zipCode	string	false
billing_addressId	string	false
shipping_description	com.ibm.commerce.foundation.common.datatypes.DescriptionType	false
shipping_organizationIdentifier	com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType	false
shipping_primary	string	false
shipping_middleName	string	false
shipping_personTitle	string	false
shipping_organizationUnitName	string	false
shipping_addressLine	string array	false
billing_taxGeoCode	string	false
billing_fax1	string	true
billing_fax2	string	true
shipping_nickName	string	true

person-checkoutProfile.CheckoutProfile.protocolData

Properties:

Name	Data Type	Required
value	string	false
name	string	true

person-checkoutProfile.CheckoutProfile.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true