listAddressTypes
get
/ccadmin/v1/addressTypes
List Address types. Get a list of address types defined by merchant
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
q(optional): string
Query string built as per the SCIM standards that helps to search entered string across property 'addressType'
-
sort(optional): string
This field determines the sort order of the list to be fetched.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listAddressTypes_response
Type:
Show Source
object
-
items(optional):
array items
List of address types
-
limit(optional):
integer
The number of items to return.
-
offset(optional):
integer
Index of the first element to return.
-
total(optional):
integer
The total number of items. Deprecated.
-
totalResults(optional):
integer
The total number of items.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
Display name of address type
-
id(optional):
string
The ID of the address type item.
-
repositoryId(optional):
string
The repository id of the address type
Example Response (application/json)
{
"total":3,
"totalResults":3,
"offset":0,
"limit":250,
"items":[
{
"displayName":"Home",
"repositoryId":"at300001",
"id":"at300001"
},
{
"displayName":"Shipping",
"repositoryId":"ss-10002",
"id":"ss-10002"
},
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10002"
}
]
}
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|
|------------------|------------------|
|180116|An internal error occurred while processing input request.|
|180108|Error retrieving list of address types.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code