List customer account addresses for billing for the given organization id.
get
/ccstore/v1/organizations/current/customerAccounts/billTo
Request
Supported Media Types
- application/json
Query Parameters
-
customerAccountIds: string
Customer account Ids whose addresses has to be fetched
-
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 search on the address properties. Search on all the address possible except address's id, address's type, partyNumber, partyId, partyName and accountId
-
sort: string
This is the field to provide sort on the address properties except addressType.
-
totalResults: boolean
Tells whether to include total and totalResults in the SCIM query.By default the value is true
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listCustomerAccountBillingAddresses_response
Type:
Show Source
object-
items:
array items
List of customer account details for given organization.
-
limit:
string
Number of records to be fetched.
-
offset:
string
The offset provided.
-
total:
string
Total number of records present in database matching the searched string.
-
totalResults:
string
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
arrayList of customer account details for given organization.
Show Source
Nested Schema : items
Type:
Show Source
object-
accountId:
string
account id for the billing account which 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
Party Id of the Customer Account
-
partyName:
string
Party name of the Customer Account
-
partyNumber:
string
Party number of the Customer Account
-
postalCode:
string
the postal Code of the address
-
setId:
string
Set id for address
-
siteId:
string
Site Id
-
siteUseId:
string
Site use Id
-
state:
string
the state of the address
-
type:
array type
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
Example Response (application/json)
{
"total":2,
"totalResults":2,
"offset":0,
"limit":2,
"items":[
{
"country":"US",
"address3":null,
"address2":null,
"city":"Atlanta",
"externalNumber":"1220",
"address1":"1156 River Street",
"postalCode":"30010",
"county":"Fulton",
"externalId":"1220",
"type":[
{
"displayName":"Billing",
"repositoryId":"BILLING",
"id":"BILLING"
}
],
"accountId":"1006",
"siteUseId":null,
"formattedAddress":"1156 River Street,ATLANTA, GA 30010",
"partyName":"Miller Manufacturing",
"state":"GA",
"id":"150001",
"partyId":"1006",
"partyNumber":"1006"
},
{
"country":"US",
"address3":"Warehouse B",
"address2":"Distribution Center",
"city":"Chattanooga",
"externalNumber":"1222",
"address1":"1800 Satellite Drive",
"postalCode":"37401",
"county":"Hamilton",
"externalId":"1222",
"type":[
{
"displayName":"Billing",
"repositoryId":"BILLING",
"id":"BILLING"
},
{
"displayName":"Shipping",
"repositoryId":"SHIPPING",
"id":"SHIPPING"
}
],
"accountId":"1006",
"siteUseId":null,
"formattedAddress":"1800 Satellite Drive,Distribution Center,CHATTANOOGA, TN 37401",
"partyName":"Miller Manufacturing",
"state":"TN",
"id":"150002",
"partyId":"1006",
"partyNumber":"1006"
}
]
}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