Jump to

• Request
• Response

Sync financial data: customer accounts, billing account, billing addresses and default shipping addresses for the provided organization id.

post

/ccadmin/v1/organizations/{id}/syncFinancialData

Sync financial data: customer accounts, billing account, billing addresses and default shipping addresses for a given organization id. Each time when this API is triggered, billing accounts and billing addresses are removed and re-created.

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Root Schema : syncFinancialData_request

Type: object

Show Source

• businessUnitId: number
  If the business unit ID is provided, billing addresses associated with that business unit will be retrieved. And any existing billing accounts and billing addresses will be replaced with new ones. If no business unit ID is supplied, the system will attempt to obtain it from the CDMAccountServices component (if configured). If still unavailable, all billing addresses linked to the specified organization's party will be fetched.

{
    "properties":{
        "businessUnitId":{
            "description":"If the business unit ID is provided, billing addresses associated with that business unit will be retrieved. And any existing billing accounts and billing addresses will be replaced with new ones. If no business unit ID is supplied, the system will attempt to obtain it from the CDMAccountServices component (if configured). If still unavailable, all billing addresses linked to the specified organization's party will be fetched.",
            "type":"number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : syncFinancialData_response

Type: object

Show Source

• customerAccountIds: array customerAccountIds
  List of repository ids of synced the Customer Accounts.
• failedAddressItems: array failedAddressItems
  List of failed addresses of the Customer Account.

{
    "properties":{
        "customerAccountIds":{
            "description":"List of repository ids of synced the Customer Accounts.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/stringType"
            }
        },
        "failedAddressItems":{
            "description":"List of failed addresses of the Customer Account.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "description":"The error message associated with the failed address item.",
                        "type":"string"
                    },
                    "externalId":{
                        "description":"The external ID of the failed address item.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : customerAccountIds

Type: array

List of repository ids of synced the Customer Accounts.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 240

{
    "description":"List of repository ids of synced the Customer Accounts.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/stringType"
    }
}

Nested Schema : failedAddressItems

Type: array

List of failed addresses of the Customer Account.

Show Source

• Array of: object items

{
    "description":"List of failed addresses of the Customer Account.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "description":"The error message associated with the failed address item.",
                "type":"string"
            },
            "externalId":{
                "description":"The external ID of the failed address item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  The error message associated with the failed address item.
• externalId: string
  The external ID of the failed address item.

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "description":"The error message associated with the failed address item.",
            "type":"string"
        },
        "externalId":{
            "description":"The external ID of the failed address item.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "customerAccountIds":[
        "ca10002",
        "ca10003",
        "ca20001"
    ],
    "failedAddressItems":[
        {
            "errorMessage":"City is not specified",
            "externalId":"300100628304102"
        },
        {
            "errorMessage":"City is not specified",
            "externalId":"17277"
        }
    ]
}

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 syncing Financial data: customer accounts and their addresses | |58001| Error if selfservice portal is not enabled| |100001|Error on invalid organization|

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