Jump to

• Request
• Response

Reject an address request

post

/ccstore/v1/organizations/current/customerAccounts/addressRequests/{addressRequestId}/reject

Rejection of a customer account address request by account address manager.

Request

Supported Media Types

• application/json

Path Parameters

• addressRequestId(required): string
  The ID of the address request to reject.

Body ()

The comment explaining why the address request is rejected.

Root Schema : schema

Type: object

Show Source

• comment: string
  The comment explaining why the address request is rejected.

  Example: Your request is rejected.

{
    "type":"object",
    "properties":{
        "comment":{
            "description":"The comment explaining why the address request is rejected.",
            "type":"string",
            "example":"Your request is rejected."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Address request has been rejected successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• links: array links
• result: string
  Example: Address request has been rejected.

{
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "example":"Address request has been rejected."
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The relationship type of the link.",
                        "type":"string",
                        "example":"self"
                    },
                    "href":{
                        "description":"The URL to interact with the address request resource.",
                        "type":"string",
                        "example":"/ccstore/v1/organizations/current/customerAccounts/addressRequests/caar-12345/reject"
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"The relationship type of the link.",
                "type":"string",
                "example":"self"
            },
            "href":{
                "description":"The URL to interact with the address request resource.",
                "type":"string",
                "example":"/ccstore/v1/organizations/current/customerAccounts/addressRequests/caar-12345/reject"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href: string
  The URL to interact with the address request resource.

  Example: /ccstore/v1/organizations/current/customerAccounts/addressRequests/caar-12345/reject
• rel: string
  The relationship type of the link.

  Example: self

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The relationship type of the link.",
            "type":"string",
            "example":"self"
        },
        "href":{
            "description":"The URL to interact with the address request resource.",
            "type":"string",
            "example":"/ccstore/v1/organizations/current/customerAccounts/addressRequests/caar-12345/reject"
        }
    }
}

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 | |------------|-------------| | 270001 | Error related to address request |

Body ()

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"
        }
    }
}

Back to Top