REST API for Oracle Commerce Cloud

List addresses for provided customer account of an organization from the external system (not from OCC)

get

/ccadmin/v1/organizations/{id}/customerAccounts/{customerAccountId}/shipTo

List Addresses for Customer Account of an Organization. This endpoint is used to get addresses for customer account of an Organization from external system.

Request

Supported Media Types

application/json

Path Parameters

customerAccountId(required): string

The customer account id for an Organization.
id(required): string

The ID of the requested Organization.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : fetchExternalCustomerAccountAddresses_response

Type: object

Show Source

count: integer

The number of items returned in the current range.
defaultShippingAddress: object defaultShippingAddress

Default shipping address for the customer account
hasMore: boolean

Returns true if more items are available than the subset returned in current page.
items: array items

list of organizations
limit: integer

Number of records to be fetched.
offset: integer

The offset provided.
totalResults: integer

Total number of records present in database matching the searched string.

{
    "properties":{
        "totalResults":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset provided.",
            "type":"integer"
        },
        "defaultShippingAddress":{
            "description":"Default shipping address for the customer account",
            "type":"object",
            "properties":{
                "types":{
                    "description":"Address type of the customer account address.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "displayName":{
                                "description":"Display name of address type",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"Repository Id of address type",
                                "type":"string"
                            },
                            "id":{
                                "description":"Id of address type",
                                "type":"string"
                            }
                        }
                    }
                },
                "formattedAddress":{
                    "description":"The formattedAddress of the customer account address",
                    "type":"string"
                },
                "externalId":{
                    "description":"External address id of customer account",
                    "type":"string"
                },
                "id":{
                    "description":"Repository id for the address",
                    "type":"string"
                }
            }
        },
        "limit":{
            "description":"Number of records to be fetched.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Returns true if more items are available than the subset returned in current page.",
            "type":"boolean"
        },
        "count":{
            "description":"The number of items returned in the current range.",
            "type":"integer"
        },
        "items":{
            "description":"list of organizations",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "types":{
                        "description":"Address type of the customer account address.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "displayName":{
                                    "description":"Display name of address type",
                                    "type":"string"
                                },
                                "repositoryId":{
                                    "description":"Repository Id of address type",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"Id of address type",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "formattedAddress":{
                        "description":"The formattedAddress of the customer account address",
                        "type":"string"
                    },
                    "externalId":{
                        "description":"External address id of customer account",
                        "type":"string"
                    },
                    "primaryFlag":{
                        "description":"Primary flag for address of organization ",
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : defaultShippingAddress

Type: object

Default shipping address for the customer account

Show Source

externalId: string

External address id of customer account
formattedAddress: string

The formattedAddress of the customer account address
id: string

Repository id for the address
types: array types

Address type of the customer account address.

{
    "description":"Default shipping address for the customer account",
    "type":"object",
    "properties":{
        "types":{
            "description":"Address type of the customer account address.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of address type",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository Id of address type",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of address type",
                        "type":"string"
                    }
                }
            }
        },
        "formattedAddress":{
            "description":"The formattedAddress of the customer account address",
            "type":"string"
        },
        "externalId":{
            "description":"External address id of customer account",
            "type":"string"
        },
        "id":{
            "description":"Repository id for the address",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

list of organizations

Show Source

Array of: object items

{
    "description":"list of organizations",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "types":{
                "description":"Address type of the customer account address.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "displayName":{
                            "description":"Display name of address type",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"Repository Id of address type",
                            "type":"string"
                        },
                        "id":{
                            "description":"Id of address type",
                            "type":"string"
                        }
                    }
                }
            },
            "formattedAddress":{
                "description":"The formattedAddress of the customer account address",
                "type":"string"
            },
            "externalId":{
                "description":"External address id of customer account",
                "type":"string"
            },
            "primaryFlag":{
                "description":"Primary flag for address of organization ",
                "type":"boolean"
            }
        }
    }
}

Nested Schema : types

Type: array

Address type of the customer account address.

Show Source

Array of: object items

{
    "description":"Address type of the customer account address.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of address type",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository Id of address type",
                "type":"string"
            },
            "id":{
                "description":"Id of address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName: string

Display name of address type
id: string

Id of address type
repositoryId: string

Repository Id of address type

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of address type",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository Id of address type",
            "type":"string"
        },
        "id":{
            "description":"Id of address type",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

externalId: string

External address id of customer account
formattedAddress: string

The formattedAddress of the customer account address
primaryFlag: boolean

Primary flag for address of organization
types: array types

Address type of the customer account address.

{
    "type":"object",
    "properties":{
        "types":{
            "description":"Address type of the customer account address.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of address type",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository Id of address type",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of address type",
                        "type":"string"
                    }
                }
            }
        },
        "formattedAddress":{
            "description":"The formattedAddress of the customer account address",
            "type":"string"
        },
        "externalId":{
            "description":"External address id of customer account",
            "type":"string"
        },
        "primaryFlag":{
            "description":"Primary flag for address of organization ",
            "type":"boolean"
        }
    }
}

Nested Schema : types

Type: array

Address type of the customer account address.

Show Source

Array of: object items

{
    "description":"Address type of the customer account address.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of address type",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository Id of address type",
                "type":"string"
            },
            "id":{
                "description":"Id of address type",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

displayName: string

Display name of address type
id: string

Id of address type
repositoryId: string

Repository Id of address type

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of address type",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository Id of address type",
            "type":"string"
        },
        "id":{
            "description":"Id of address type",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "totalResults":45,
    "offset":0,
    "defaultShippingAddress":{
        "types":[
            "addressType:SHIPPING"
        ],
        "formattedAddress":"1800 Satellite Drive,Distribution Center,CHATTANOOGA, TN 37401",
        "externalId":"1222",
        "id":"530042"
    },
    "count":5,
    "hasMore":true,
    "limit":5,
    "items":[
        {
            "types":[
                {
                    "displayName":"Shipping",
                    "repositoryId":"SHIPPING",
                    "id":"SHIPPING"
                }
            ],
            "formattedAddress":"50 King Street,TORONTO ON  M5H3Y2,CANADA",
            "externalId":"1035",
            "primaryFlag":false
        },
        {
            "types":[
                {
                    "displayName":"Shipping",
                    "repositoryId":"SHIPPING",
                    "id":"SHIPPING"
                }
            ],
            "formattedAddress":"2164 Broadway,TEMPE, AZ 85282",
            "externalId":"1036",
            "primaryFlag":false
        },
        {
            "types":[
                {
                    "displayName":"Shipping",
                    "repositoryId":"SHIPPING",
                    "id":"SHIPPING"
                }
            ],
            "formattedAddress":"1156 River Street,ATLANTA, GA 30301",
            "externalId":"1037",
            "primaryFlag":false
        },
        {
            "types":[
                {
                    "displayName":"Shipping",
                    "repositoryId":"SHIPPING",
                    "id":"SHIPPING"
                }
            ],
            "formattedAddress":"50 King Street,TORONTO ON  M5H3Y2,CANADA",
            "externalId":"1088",
            "primaryFlag":false
        },
        {
            "types":[
                {
                    "displayName":"Billing",
                    "repositoryId":"BILLING",
                    "id":"BILLING"
                },
                {
                    "displayName":"Shipping",
                    "repositoryId":"SHIPPING",
                    "id":"SHIPPING"
                }
            ],
            "formattedAddress":"302 Executive Circle,Warehouse B,CHATTANOOGA, TN 37401",
            "externalId":"1090",
            "primaryFlag":false
        }
    ]
}

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| |------------------|------------------| |59001|If there is an issue while processing addresses for customer account of an organization| |100093|If there an issue while adding addresses for customer account of an organization |

Root Schema : errorModel

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}