List customer accounts details for the provided organization id.
get
/ccstore/v1/organizations/current/customerAccounts
List customer accounts details for the provided organization id.
Request
Supported Media Types
- application/json
Query Parameters
-
limit: string
This is the field to determine number of records to be fetched per REST call.
-
offset: string
This field determines the offset/starting index from which data to be fetched.
-
q: string
SCIM query to filter on the customer accounts. It does not support properties: defaultShipTo, defaultBillTo and repositoryId.
-
sort: string
This is the field to provide sort on customer accounts. It does not support properties: defaultShipTo, defaultBillTo and repositoryId.
-
totalResults: boolean
Tells whether to include total and totalResults in the SCIM query.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listCustomerAccounts_response
Type:
Show Source
object-
invalidItemIds:
array invalidItemIds
Invalid/Failed external Address Ids of the Customer Account's addresses which are not synced.
-
items:
array items
List of customer account details for given organization.
Nested Schema : invalidItemIds
Type:
arrayInvalid/Failed external Address Ids of the Customer Account's addresses which are not synced.
Show Source
-
Array of:
string
Minimum Length:
1Maximum Length:240
Nested Schema : items
Type:
arrayList of customer account details for given organization.
Show Source
Nested Schema : items
Type:
Show Source
object-
defaultBillTo:
object defaultBillTo
Default bill-to address for the Customer Account
-
defaultShipTo:
object defaultShipTo
Default ship-to address for the Customer Account
-
id:
string
Repository Id of the Customer Account.
-
partyId:
string
Party Id of the Customer Account
-
partyName:
string
Party name of the Customer Account
-
partyNumber:
string
Party number of the Customer Account
Nested Schema : defaultBillTo
Type:
objectDefault bill-to address for the Customer Account
Show Source
-
accountId:
string
Account Id of the billing account under the customer account that this address belongs to
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
address3:
string
the address3 of the address
-
city:
string
the city of the address
-
country:
string
the country of the address
-
county:
string
the county of the address
-
externalId:
string
External address id
-
externalNumber:
string
External address number
-
formattedAddress:
string
the formatted address
-
id:
string
repository Id of the address
-
partyId:
string
partyId of the customer account that this address belongs to
-
partyName:
string
Party name of the Customer Account
-
partyNumber:
string
partyNumber of the customer account that this address belongs to
-
postalCode:
string
the postal Code of the address
-
setId:
string
Set id for address
-
siteUseId:
string
Site use Id
-
state:
string
the state of the address
-
types:
array types
The types tagged to the address
Nested Schema : defaultShipTo
Type:
objectDefault ship-to address for the Customer Account
Show Source
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
address3:
string
the address3 of the address
-
city:
string
the city of the address
-
country:
string
the country of the address
-
county:
string
the county of the address
-
externalId:
string
External address id
-
externalNumber:
string
External address number
-
formattedAddress:
string
the formatted address
-
id:
string
repository Id of the address
-
partyId:
string
partyId of the customer account that this address belongs to
-
partyName:
string
Party name of the Customer Account
-
partyNumber:
string
partyNumber of the customer account that this address belongs to
-
postalCode:
string
the postal Code of the address
-
setId:
string
Set id for address
-
siteUseId:
string
Site use Id
-
state:
string
the state of the address
-
types:
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object-
displayName:
string
The name of the address type
-
id:
string
repository Id of the address type
-
repositoryId:
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object-
displayName:
string
The name of the address type
-
id:
string
repository Id of the address type
-
repositoryId:
string
repository Id of the address type
Example Response (application/json)
{
"items":[
{
"defaultShipTo":{
"country":"US",
"address3":null,
"address2":null,
"city":"St Cloud",
"externalNumber":"4831",
"address1":"933 Blackberry Creek Ave",
"addressType":[
{
"displayName":"Shipping",
"repositoryId":"SHIPPING",
"id":"SHIPPING"
}
],
"postalCode":"34769",
"county":"Osceola",
"externalId":"12356",
"siteUseId":null,
"formattedAddress":"933 Blackberry Creek Ave,ST CLOUD, FL 34769",
"repositoryId":"240016",
"partyName":"Miller Manufacturing",
"state":"FL",
"id":"240016",
"partyId":"1234",
"partyNumber":"3456"
},
"repositoryId":"ca150002",
"partyName":"Miller Manufacturing",
"defaultBillTo":{
"country":"US",
"address3":null,
"address2":null,
"city":"St Cloud",
"externalNumber":"4831",
"address1":"933 Blackberry Creek Ave",
"addressType":[
{
"displayName":"Billing",
"repositoryId":"BILLING",
"id":"BILLING"
}
],
"postalCode":"34769",
"county":"Osceola",
"externalId":"12345",
"accountId":"4564",
"siteUseId":"5282",
"formattedAddress":"933 Blackberry Creek Ave,ST CLOUD, FL 34769",
"repositoryId":"240014",
"partyName":"Miller Manufacturing",
"state":"FL",
"id":"240014",
"partyId":"1234",
"partyNumber":"3456"
},
"billingAccounts":[
{
"accountId":"4564",
"accountName":"Miller Manufacturing",
"repositoryId":"ba10001",
"id":"ba10001",
"accountNumber":"2058"
}
],
"defaultBillingAccountId":"4564",
"id":"ca150002",
"partyId":"12747",
"partyNumber":"10252"
}
]
}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|
|------------------|------------------|
|100193|Internal error occurred while fetching customer accounts|
|100001|invalid organization Id|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code