getResourceMetadata
get
/ccadmin/v1/metadata-catalog/{id}
Get Resource Metadata. Returns the metadata catalog of the resource specified
Request
Supported Media Types
- application/json
Path Parameters
- id
-
Type:
stringRequired:trueThe ID of the resource
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getResourceMetadata_response
- $schema
-
Type:
stringlocation of schema for the given resource - definitions
-
Type:
objectdefinitionsAdditional Properties Allowed:respective properties of the resource - description
-
Type:
stringdescription of the resource being retrieved - title
-
Type:
stringtitle of metadata resource - token
-
Type:
stringThe auth token for the Endpoint - type
-
Type:
stringtype of metadata resource
Nested Schema : definitions
Type:
objectrespective properties of the resource
Example application/json
{
"$schema":"rest-schemas/",
"description":"The details of customer profile created on Oracle Commerce Cloud. This includes account based commerce, the customer profile includes email, first name and last name.",
"title":"profiles",
"type":"object",
"definitions":{
"createProfile_response":{
"properties":{
"id":{
"description":"Repository id of the profile",
"type":"string"
}
}
},
"resetPassword_request":{
"properties":{
"login":{
"description":"login of the user.",
"type":"string"
}
},
"required":[
"login"
]
},
"updateProfile_request":{
"properties":{
"dynamicProperty":{
"description":"the value of the dynamic property",
"type":"object"
},
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"profileType":{
"description":"This attribute is added for account based commerce. It's value is 'b2b_user'",
"type":"string"
},
"receiveEmail":{
"description":"this is email marketing flag. can be yes or no",
"type":"string"
},
"dynamicInternalOnlyProperty":{
"description":"the value of the internal only dynamic property",
"type":"object"
},
"active":{
"description":"the status of the profile. Should be true or false",
"type":"boolean"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"string"
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"daytimeTelephoneNumber":{
"description":"the phone Number of the profile",
"type":"string"
}
},
"required":[
"lastName",
"email",
"active",
"firstName"
]
},
"getProfile_response":{
"properties":{
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"catalog":{
"description":"This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type":"string"
},
"receiveEmail":{
"description":"this is email marketing flag. can be yes or no",
"type":"string"
},
"dynamicInternalOnlyProperty":{
"description":"the value of the internal only dynamic property",
"type":"object"
},
"active":{
"description":"the user status of the profile. Should be true or false",
"type":"boolean"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"Description of the Organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the organization",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
},
"dynamicProperty":{
"description":"the value of the dynamic Property",
"type":"object"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"profileType":{
"description":"This attribute is added for account based commerce, It's value is 'b2b_user'",
"type":"string"
},
"repositoryId":{
"description":"the id of the profile",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"id":{
"description":"get the shopper profile with id",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"shippingAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"daytimeTelephoneNumber":{
"description":"the phone Number of the profile",
"type":"string"
}
}
},
"updateProfile_response":{
"properties":{
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"catalog":{
"description":"This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type":"string"
},
"receiveEmail":{
"description":"this is email marketing flag. Can be yes or no",
"type":"string"
},
"dynamicInternalOnlyProperty":{
"description":"the value of the internal only dynamic property",
"type":"object"
},
"active":{
"description":"the status of the profile. Should be true or false",
"type":"boolean"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"Description of the Organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
}
}
},
"dynamicProperty":{
"description":"the value of the dynamic property",
"type":"object"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"profileType":{
"description":"This attribute is added for account based commerce. It's value is 'b2b_user'",
"type":"string"
},
"repositoryId":{
"description":"the id of the profile",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"id":{
"description":"the id of the profile to retrieve",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"shippingAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"daytimeTelephoneNumber":{
"description":"the phone Number of the profile",
"type":"string"
}
}
},
"profiles":{
"links":[
{
"schema":{
"ref":"#/definitions/resetPassword_request"
},
"targetSchema":{
"ref":"#/definitions/resetPassword_response"
},
"requestHeaders":{
"type":"object",
"properties":{
"X-CCAsset-Language":{
"description":"The asset language of the request",
"type":"string"
}
}
},
"method":"POST",
"rel":"resetPassword",
"mediaType":"application/json",
"href":"http://localhost:9080/ccadmin/v1/profiles/resetPassword",
"title":"Reset Password. This operation is used to reset the password of a customer profile. Optionally takes the x-ccasset-language header to get translated content in another language."
},
{
"targetSchema":{
"ref":"#/definitions/getProfile_response"
},
"requestHeaders":{
"type":"object",
"properties":{
"X-CCAsset-Language":{
"description":"The asset language of the request",
"type":"string"
}
}
},
"method":"GET",
"rel":"getProfile",
"mediaType":"application/json",
"href":"http://localhost:9080/ccadmin/v1/profiles/{id}",
"title":"Get Profile. This operation is used to get the profile information of a customer from Oracle Commerce Cloud. Optionally takes the x-ccasset-language header to get translated content in another language."
},
{
"schema":{
"ref":"#/definitions/updateProfile_request"
},
"targetSchema":{
"ref":"#/definitions/updateProfile_response"
},
"requestHeaders":{
"type":"object",
"properties":{
"X-CCAsset-Language":{
"description":"The asset language of the request",
"type":"string"
}
}
},
"method":"PUT",
"rel":"updateProfile",
"mediaType":"application/json",
"href":"http://localhost:9080/ccadmin/v1/profiles/{id}",
"title":"Update Profile. This operation is used to update customer name, email address, phone number, shipping address and email marketing flag status of a customer profile. Optionally takes the x-ccasset-language header to get translated content in another language."
},
{
"schema":{
"ref":"#/definitions/createProfile_request"
},
"targetSchema":{
"ref":"#/definitions/createProfile_response"
},
"requestHeaders":{
"type":"object",
"properties":{
"X-CCAsset-Language":{
"description":"The asset language of the request",
"type":"string"
}
}
},
"method":"POST",
"rel":"createProfile",
"mediaType":"application/json",
"href":"http://localhost:9080/ccadmin/v1/profiles",
"title":"Create Profile. This operation is used to create a profile in Oracle Commerce Cloud for a customer. Optionally takes the x-ccasset-language header to get translated content in another language."
}
],
"properties":{
"total":{
"description":"Total number of records present in database matching the searched string.",
"type":"string"
},
"limit":{
"description":"Number of records to be fetched.",
"type":"string"
},
"items":{
"description":"list of shopper profiles",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"profiletype":{
"description":"This attribute is added for account based commerce. It's value is 'b2b_user'",
"type":"string"
},
"catalog":{
"description":"This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type":"string"
},
"receiveEmail":{
"description":"this is email marketing flag. can be yes or no",
"type":"string"
},
"dynamicInternalOnlyProperty":{
"description":"The value of the internalOnly dynamic property",
"type":"object"
},
"active":{
"description":"the user status of the profile. Should be true or false",
"type":"boolean"
},
"locale":{
"description":"the locale of the request/response",
"type":"string"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"object",
"properties":{
"name":{
"description":"the name of the parent organization",
"type":"string"
},
"repositoryId":{
"description":"the id of the parent organization",
"type":"string"
},
"description":{
"description":"the description of the parent organization",
"type":"string"
},
"active":{
"description":"the status of the parent organization. Should be true or false",
"type":"boolean"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
}
}
},
"secondaryAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
}
}
}
},
"id":{
"description":"the id of the parent organization",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
}
}
}
}
},
"dynamicProperty":{
"description":"the value of the dynamic property",
"type":"object"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"repositoryId":{
"description":"the id of the profile",
"type":"string"
},
"shippingAddress":{
"description":"Default shipping address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
},
"id":{
"description":"the id of the profile to retrieve",
"type":"string"
},
"billingAddress":{
"description":"Default billing address of the profile",
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the billing address",
"type":"string"
},
"firstName":{
"description":"the first name of the billing address",
"type":"string"
},
"country":{
"description":"the country of the billing address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the billing address",
"type":"string"
},
"address2":{
"description":"the address2 of the billing address",
"type":"string"
},
"city":{
"description":"the city of the billing address",
"type":"string"
},
"address1":{
"description":"the address1 of the billing address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the billing address",
"type":"string"
},
"county":{
"description":"the county of the billing address",
"type":"string"
},
"repositoryId":{
"description":"the id of the billing address",
"type":"string"
},
"state":{
"description":"the state of the billing address",
"type":"string"
}
}
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"shippingAddresses":{
"description":"List of shipping addresses associated with profile.",
"type":"array",
"items":{
"type":"object",
"properties":{
"lastName":{
"description":"the last name of the shipping address",
"type":"string"
},
"firstName":{
"description":"the first name of the shipping address",
"type":"string"
},
"country":{
"description":"the country of the shipping address",
"type":"string"
},
"phoneNumber":{
"description":"the phone Number of the shipping address",
"type":"string"
},
"address2":{
"description":"the address2 of the shipping address",
"type":"string"
},
"city":{
"description":"the city of the shipping address",
"type":"string"
},
"address1":{
"description":"the address1 of the shipping address",
"type":"string"
},
"postalCode":{
"description":"the postal Code of the shipping address",
"type":"string"
},
"county":{
"description":"the county of the shipping address",
"type":"string"
},
"repositoryId":{
"description":"the id of the shipping address",
"type":"string"
},
"state":{
"description":"the state of the shipping address",
"type":"string"
}
}
}
},
"daytimeTelephoneNumber":{
"description":"the phone Number of the profile",
"type":"string"
}
}
}
}
}
},
"createProfile_request":{
"properties":{
"dynamicProperty":{
"description":"the value of the dynamic property",
"type":"object"
},
"lastName":{
"description":"the last name of the profile",
"type":"string"
},
"firstName":{
"description":"the first name of the profile",
"type":"string"
},
"profileType":{
"description":"This attribute is added for account based commerce. It's value is 'b2b_user'",
"type":"string"
},
"receiveEmail":{
"description":"the string representation of whether the user wants to recieve email or not, it should be 'yes' or 'no'",
"type":"string"
},
"dynamicInternalOnlyProperty":{
"description":"the value of the internal only dynamic property",
"type":"object"
},
"active":{
"description":"the status of the profile. Should be true or false",
"type":"boolean"
},
"parentOrganization":{
"description":"This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type":"string"
},
"email":{
"description":"the email address of the profile",
"type":"string"
},
"daytimeTelephoneNumber":{
"description":"the phone Number of the profile",
"type":"string"
}
},
"required":[
"receiveEmail",
"lastName",
"email",
"active",
"firstName"
]
},
"resetPassword_response":{
"properties":{
"success":{
"description":"Returns true irrespective of existence of the profile.",
"type":"boolean"
}
}
}
}
}Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|13101|METADATA INTERNAL ERROR|
Body
Root Schema : errorModel
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - errors
-
Type:
arrayerrorsAdditional Properties Allowed:An optional list of errors if multiple errors were encountered - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code - type
-
Type:
stringThe URI to the HTTP state code definition
Nested Schema : errors
Nested Schema : items
Type:
object- devMessage
-
Type:
stringAn optional non-localized message containing technical information for developers - errorCode
-
Type:
stringThe numerical code identifying the error - message
-
Type:
stringThe localized message describing the error - moreInfo
-
Type:
stringAn optional non-localized message with more information - o:errorPath
-
Type:
stringAn optional machine readable description of where the error occurred - status
-
Type:
stringThe HTTP status code
Examples
Sample Response Payload returned by endpoint:
{
"$schema": "rest-schemas/",
"description": "The details of customer profile created on Oracle Commerce Cloud. This includes account based commerce, the customer profile includes email, first name and last name.",
"title": "profiles",
"type": "object",
"definitions": {
"createProfile_response": {"properties": {"id": {
"description": "Repository id of the profile",
"type": "string"
}}},
"resetPassword_request": {
"properties": {"login": {
"description": "login of the user.",
"type": "string"
}},
"required": ["login"]
},
"updateProfile_request": {
"properties": {
"dynamicProperty": {
"description": "the value of the dynamic property",
"type": "object"
},
"lastName": {
"description": "the last name of the profile",
"type": "string"
},
"firstName": {
"description": "the first name of the profile",
"type": "string"
},
"profileType": {
"description": "This attribute is added for account based commerce. It's value is 'b2b_user'",
"type": "string"
},
"receiveEmail": {
"description": "this is email marketing flag. can be yes or no",
"type": "string"
},
"dynamicInternalOnlyProperty": {
"description": "the value of the internal only dynamic property",
"type": "object"
},
"active": {
"description": "the status of the profile. Should be true or false",
"type": "boolean"
},
"parentOrganization": {
"description": "This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type": "string"
},
"email": {
"description": "the email address of the profile",
"type": "string"
},
"daytimeTelephoneNumber": {
"description": "the phone Number of the profile",
"type": "string"
}
},
"required": [
"lastName",
"email",
"active",
"firstName"
]
},
"getProfile_response": {"properties": {
"lastName": {
"description": "the last name of the profile",
"type": "string"
},
"catalog": {
"description": "This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type": "string"
},
"receiveEmail": {
"description": "this is email marketing flag. can be yes or no",
"type": "string"
},
"dynamicInternalOnlyProperty": {
"description": "the value of the internal only dynamic property",
"type": "object"
},
"active": {
"description": "the user status of the profile. Should be true or false",
"type": "boolean"
},
"locale": {
"description": "the locale of the request/response",
"type": "string"
},
"parentOrganization": {
"description": "This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type": "object",
"properties": {
"name": {
"description": "the name of the parent organization",
"type": "string"
},
"repositoryId": {
"description": "the id of the parent organization",
"type": "string"
},
"description": {
"description": "Description of the Organization",
"type": "string"
},
"active": {
"description": "the status of the parent organization. Should be true or false",
"type": "boolean"
},
"shippingAddress": {
"description": "Default shipping address of the organization",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
},
"secondaryAddresses": {
"description": "List of shipping addresses associated with profile.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
}
},
"id": {
"description": "the id of the parent organization",
"type": "string"
},
"billingAddress": {
"description": "Default billing address of the organization",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the billing address",
"type": "string"
},
"firstName": {
"description": "the first name of the billing address",
"type": "string"
},
"country": {
"description": "the country of the billing address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the billing address",
"type": "string"
},
"address2": {
"description": "the address2 of the billing address",
"type": "string"
},
"city": {
"description": "the city of the billing address",
"type": "string"
},
"address1": {
"description": "the address1 of the billing address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the billing address",
"type": "string"
},
"county": {
"description": "the county of the billing address",
"type": "string"
},
"repositoryId": {
"description": "the id of the billing address",
"type": "string"
},
"state": {
"description": "the state of the billing address",
"type": "string"
}
}
}
}
},
"dynamicProperty": {
"description": "the value of the dynamic Property",
"type": "object"
},
"firstName": {
"description": "the first name of the profile",
"type": "string"
},
"profileType": {
"description": "This attribute is added for account based commerce, It's value is 'b2b_user'",
"type": "string"
},
"repositoryId": {
"description": "the id of the profile",
"type": "string"
},
"shippingAddress": {
"description": "Default shipping address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
},
"id": {
"description": "get the shopper profile with id",
"type": "string"
},
"billingAddress": {
"description": "Default billing address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the billing address",
"type": "string"
},
"firstName": {
"description": "the first name of the billing address",
"type": "string"
},
"country": {
"description": "the country of the billing address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the billing address",
"type": "string"
},
"address2": {
"description": "the address2 of the billing address",
"type": "string"
},
"city": {
"description": "the city of the billing address",
"type": "string"
},
"address1": {
"description": "the address1 of the billing address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the billing address",
"type": "string"
},
"county": {
"description": "the county of the billing address",
"type": "string"
},
"repositoryId": {
"description": "the id of the billing address",
"type": "string"
},
"state": {
"description": "the state of the billing address",
"type": "string"
}
}
},
"email": {
"description": "the email address of the profile",
"type": "string"
},
"shippingAddresses": {
"description": "List of shipping addresses associated with profile.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
}
},
"daytimeTelephoneNumber": {
"description": "the phone Number of the profile",
"type": "string"
}
}},
"updateProfile_response": {"properties": {
"lastName": {
"description": "the last name of the profile",
"type": "string"
},
"catalog": {
"description": "This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type": "string"
},
"receiveEmail": {
"description": "this is email marketing flag. Can be yes or no",
"type": "string"
},
"dynamicInternalOnlyProperty": {
"description": "the value of the internal only dynamic property",
"type": "object"
},
"active": {
"description": "the status of the profile. Should be true or false",
"type": "boolean"
},
"locale": {
"description": "the locale of the request/response",
"type": "string"
},
"parentOrganization": {
"description": "This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type": "object",
"properties": {
"name": {
"description": "the name of the parent organization",
"type": "string"
},
"repositoryId": {
"description": "the id of the parent organization",
"type": "string"
},
"description": {
"description": "Description of the Organization",
"type": "string"
},
"active": {
"description": "the status of the parent organization. Should be true or false",
"type": "boolean"
},
"shippingAddress": {
"description": "Default shipping address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
},
"secondaryAddresses": {
"description": "List of shipping addresses associated with profile.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
}
},
"id": {
"description": "the id of the parent organization",
"type": "string"
},
"billingAddress": {
"description": "Default billing address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the billing address",
"type": "string"
},
"firstName": {
"description": "the first name of the billing address",
"type": "string"
},
"country": {
"description": "the country of the billing address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the billing address",
"type": "string"
},
"address2": {
"description": "the address2 of the billing address",
"type": "string"
},
"city": {
"description": "the city of the billing address",
"type": "string"
},
"address1": {
"description": "the address1 of the billing address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the billing address",
"type": "string"
},
"county": {
"description": "the county of the billing address",
"type": "string"
},
"repositoryId": {
"description": "the id of the billing address",
"type": "string"
},
"state": {
"description": "the state of the billing address",
"type": "string"
}
}
}
}
},
"dynamicProperty": {
"description": "the value of the dynamic property",
"type": "object"
},
"firstName": {
"description": "the first name of the profile",
"type": "string"
},
"profileType": {
"description": "This attribute is added for account based commerce. It's value is 'b2b_user'",
"type": "string"
},
"repositoryId": {
"description": "the id of the profile",
"type": "string"
},
"shippingAddress": {
"description": "Default shipping address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
},
"id": {
"description": "the id of the profile to retrieve",
"type": "string"
},
"billingAddress": {
"description": "Default billing address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the billing address",
"type": "string"
},
"firstName": {
"description": "the first name of the billing address",
"type": "string"
},
"country": {
"description": "the country of the billing address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the billing address",
"type": "string"
},
"address2": {
"description": "the address2 of the billing address",
"type": "string"
},
"city": {
"description": "the city of the billing address",
"type": "string"
},
"address1": {
"description": "the address1 of the billing address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the billing address",
"type": "string"
},
"county": {
"description": "the county of the billing address",
"type": "string"
},
"repositoryId": {
"description": "the id of the billing address",
"type": "string"
},
"state": {
"description": "the state of the billing address",
"type": "string"
}
}
},
"email": {
"description": "the email address of the profile",
"type": "string"
},
"shippingAddresses": {
"description": "List of shipping addresses associated with profile.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
}
},
"daytimeTelephoneNumber": {
"description": "the phone Number of the profile",
"type": "string"
}
}},
"profiles": {
"links": [
{
"schema": {"ref": "#/definitions/resetPassword_request"},
"targetSchema": {"ref": "#/definitions/resetPassword_response"},
"requestHeaders": {
"type": "object",
"properties": {"X-CCAsset-Language": {
"description": "The asset language of the request",
"type": "string"
}}
},
"method": "POST",
"rel": "resetPassword",
"mediaType": "application/json",
"href": "http://localhost:9080/ccadmin/v1/profiles/resetPassword",
"title": "Reset Password. This operation is used to reset the password of a customer profile. Optionally takes the x-ccasset-language header to get translated content in another language."
},
{
"targetSchema": {"ref": "#/definitions/getProfile_response"},
"requestHeaders": {
"type": "object",
"properties": {"X-CCAsset-Language": {
"description": "The asset language of the request",
"type": "string"
}}
},
"method": "GET",
"rel": "getProfile",
"mediaType": "application/json",
"href": "http://localhost:9080/ccadmin/v1/profiles/{id}",
"title": "Get Profile. This operation is used to get the profile information of a customer from Oracle Commerce Cloud. Optionally takes the x-ccasset-language header to get translated content in another language."
},
{
"schema": {"ref": "#/definitions/updateProfile_request"},
"targetSchema": {"ref": "#/definitions/updateProfile_response"},
"requestHeaders": {
"type": "object",
"properties": {"X-CCAsset-Language": {
"description": "The asset language of the request",
"type": "string"
}}
},
"method": "PUT",
"rel": "updateProfile",
"mediaType": "application/json",
"href": "http://localhost:9080/ccadmin/v1/profiles/{id}",
"title": "Update Profile. This operation is used to update customer name, email address, phone number, shipping address and email marketing flag status of a customer profile. Optionally takes the x-ccasset-language header to get translated content in another language."
},
{
"schema": {"ref": "#/definitions/createProfile_request"},
"targetSchema": {"ref": "#/definitions/createProfile_response"},
"requestHeaders": {
"type": "object",
"properties": {"X-CCAsset-Language": {
"description": "The asset language of the request",
"type": "string"
}}
},
"method": "POST",
"rel": "createProfile",
"mediaType": "application/json",
"href": "http://localhost:9080/ccadmin/v1/profiles",
"title": "Create Profile. This operation is used to create a profile in Oracle Commerce Cloud for a customer. Optionally takes the x-ccasset-language header to get translated content in another language."
}
],
"properties": {
"total": {
"description": "Total number of records present in database matching the searched string.",
"type": "string"
},
"limit": {
"description": "Number of records to be fetched.",
"type": "string"
},
"items": {
"description": "list of shopper profiles",
"type": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the profile",
"type": "string"
},
"profiletype": {
"description": "This attribute is added for account based commerce. It's value is 'b2b_user'",
"type": "string"
},
"catalog": {
"description": "This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated",
"type": "string"
},
"receiveEmail": {
"description": "this is email marketing flag. can be yes or no",
"type": "string"
},
"dynamicInternalOnlyProperty": {
"description": "The value of the internalOnly dynamic property",
"type": "object"
},
"active": {
"description": "the user status of the profile. Should be true or false",
"type": "boolean"
},
"locale": {
"description": "the locale of the request/response",
"type": "string"
},
"parentOrganization": {
"description": "This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type": "object",
"properties": {
"name": {
"description": "the name of the parent organization",
"type": "string"
},
"repositoryId": {
"description": "the id of the parent organization",
"type": "string"
},
"description": {
"description": "the description of the parent organization",
"type": "string"
},
"active": {
"description": "the status of the parent organization. Should be true or false",
"type": "boolean"
},
"shippingAddress": {
"description": "Default shipping address of the profile",
"type": "object",
"properties": {"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
}}
},
"secondaryAddresses": {
"description": "List of shipping addresses associated with profile.",
"type": "array",
"items": {
"type": "object",
"properties": {"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
}}
}
},
"id": {
"description": "the id of the parent organization",
"type": "string"
},
"billingAddress": {
"description": "Default billing address of the profile",
"type": "object",
"properties": {"repositoryId": {
"description": "the id of the billing address",
"type": "string"
}}
}
}
},
"dynamicProperty": {
"description": "the value of the dynamic property",
"type": "object"
},
"firstName": {
"description": "the first name of the profile",
"type": "string"
},
"repositoryId": {
"description": "the id of the profile",
"type": "string"
},
"shippingAddress": {
"description": "Default shipping address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
},
"id": {
"description": "the id of the profile to retrieve",
"type": "string"
},
"billingAddress": {
"description": "Default billing address of the profile",
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the billing address",
"type": "string"
},
"firstName": {
"description": "the first name of the billing address",
"type": "string"
},
"country": {
"description": "the country of the billing address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the billing address",
"type": "string"
},
"address2": {
"description": "the address2 of the billing address",
"type": "string"
},
"city": {
"description": "the city of the billing address",
"type": "string"
},
"address1": {
"description": "the address1 of the billing address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the billing address",
"type": "string"
},
"county": {
"description": "the county of the billing address",
"type": "string"
},
"repositoryId": {
"description": "the id of the billing address",
"type": "string"
},
"state": {
"description": "the state of the billing address",
"type": "string"
}
}
},
"email": {
"description": "the email address of the profile",
"type": "string"
},
"shippingAddresses": {
"description": "List of shipping addresses associated with profile.",
"type": "array",
"items": {
"type": "object",
"properties": {
"lastName": {
"description": "the last name of the shipping address",
"type": "string"
},
"firstName": {
"description": "the first name of the shipping address",
"type": "string"
},
"country": {
"description": "the country of the shipping address",
"type": "string"
},
"phoneNumber": {
"description": "the phone Number of the shipping address",
"type": "string"
},
"address2": {
"description": "the address2 of the shipping address",
"type": "string"
},
"city": {
"description": "the city of the shipping address",
"type": "string"
},
"address1": {
"description": "the address1 of the shipping address",
"type": "string"
},
"postalCode": {
"description": "the postal Code of the shipping address",
"type": "string"
},
"county": {
"description": "the county of the shipping address",
"type": "string"
},
"repositoryId": {
"description": "the id of the shipping address",
"type": "string"
},
"state": {
"description": "the state of the shipping address",
"type": "string"
}
}
}
},
"daytimeTelephoneNumber": {
"description": "the phone Number of the profile",
"type": "string"
}
}
}
}
}
},
"createProfile_request": {
"properties": {
"dynamicProperty": {
"description": "the value of the dynamic property",
"type": "object"
},
"lastName": {
"description": "the last name of the profile",
"type": "string"
},
"firstName": {
"description": "the first name of the profile",
"type": "string"
},
"profileType": {
"description": "This attribute is added for account based commerce. It's value is 'b2b_user'",
"type": "string"
},
"receiveEmail": {
"description": "the string representation of whether the user wants to recieve email or not, it should be 'yes' or 'no'",
"type": "string"
},
"dynamicInternalOnlyProperty": {
"description": "the value of the internal only dynamic property",
"type": "object"
},
"active": {
"description": "the status of the profile. Should be true or false",
"type": "boolean"
},
"parentOrganization": {
"description": "This attribute is added for 'Account Based Commerce', this is required only in case of 'Account Based Commerce', this is the id of organization to which user is associated",
"type": "string"
},
"email": {
"description": "the email address of the profile",
"type": "string"
},
"daytimeTelephoneNumber": {
"description": "the phone Number of the profile",
"type": "string"
}
},
"required": [
"receiveEmail",
"lastName",
"email",
"active",
"firstName"
]
},
"resetPassword_response": {"properties": {"success": {
"description": "Returns true irrespective of existence of the profile.",
"type": "boolean"
}}}
}
}