Jump to

• Request
• Response

Delete addresses for shipping for given customer account id under given organization id

post

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

Supports a configurable limit (default: 25 items)

Request

Supported Media Types

• application/json

Path Parameters

• customerAccountId(required): string
  The ID of the requested Customer Account of the Organization.
• id(required): string
  The ID of the requested Organization.

Body ()

Root Schema : deleteCustomerAccountAddresses_request

Type: object

Show Source

• itemIds(required): array itemIds
  Minimum Number of Items: 1

  Repository IDs of addresses for shipping that are to be deleted for the given customer account ID under the given organization ID.

{
    "properties":{
        "itemIds":{
            "minItems":1,
            "description":"Repository IDs of addresses for shipping that are to be deleted for the given customer account ID under the given organization ID.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/stringType"
            }
        }
    },
    "required":[
        "itemIds"
    ],
    "example":{
        "itemIds":[
            "1035",
            "1034"
        ]
    }
}

Example:

{
    "itemIds":[
        "1035",
        "1034"
    ]
}

Nested Schema : itemIds

Type: array

Minimum Number of Items: 1

Repository IDs of addresses for shipping that are to be deleted for the given customer account ID under the given organization ID.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 240

{
    "minItems":1,
    "description":"Repository IDs of addresses for shipping that are to be deleted for the given customer account ID under the given organization ID.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/stringType"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : deleteCustomerAccountAddress_response

Type: object

Show Source

• invalidItemIds: array invalidItemIds
  List of invalid/failed address ids of which could not be deleted.
• resultingItemIds: array resultingItemIds
  List of repository ids of currently present addresses for shipping of customer account

{
    "properties":{
        "invalidItemIds":{
            "description":"List of invalid/failed address ids of which could not be deleted.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/stringType"
            }
        },
        "resultingItemIds":{
            "description":"List of repository ids of currently present addresses for shipping of customer account",
            "type":"array",
            "items":{
                "$ref":"#/definitions/stringType"
            }
        }
    }
}

Nested Schema : invalidItemIds

Type: array

List of invalid/failed address ids of which could not be deleted.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 240

{
    "description":"List of invalid/failed address ids of which could not be deleted.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/stringType"
    }
}

Nested Schema : resultingItemIds

Type: array

List of repository ids of currently present addresses for shipping of customer account

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 240

{
    "description":"List of repository ids of currently present addresses for shipping of customer account",
    "type":"array",
    "items":{
        "$ref":"#/definitions/stringType"
    }
}

Example Response (application/json)

{
    "invalidItemIds":[
        "10002"
    ],
    "resultingItemIds":[
        "10001",
        "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| |------------------|------------------| |10194|Invalid Input| |100193| Internal error occurred while deleting addresses for customer account|

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