p2m store data updated

Type: object
Domain: audit
Event: store_data_change
Version: 1

|
method required

Title: Method
Description: The HTTP Method of contract data change operation
Type: string
Example:
POST

uri required

Title: URI
Description: The URI of contract data change operation
Type: string or null
Example:
/v1/clientes/:merchantDocument/contratos/:contractCode
null

email

Title: E-mail
Description: The operator email of contract data change operation
Type: string or null
Example:
[email protected]
null

operator_profile

Title: Operator profile
Description: The operator profile of contract data change operation
Type: string or null
Example:
[email protected]
null

object required

Title: Object
Description: The object that represents the store data change operation
Type: object

old_status required

Title: Old status
Description: The store old status
Type: string
Example:
Ativo
Inativo

new_status required

Title: New status
Description: The store new status
Type: string
Example:
Ativo
Inativo

store_code required

Title: Store code
Description: The store code identifier
Type: string
Example:
000001

merchant_document required

Title: Merchant document
Description: The merchant reference document
Type: string
Example:
99999999999999
99999999999

old_address required

Title: Old address
Description: The store old address information
Type: object

main

Title: Main address
Description: The store address street
Type: string or null
Example:
Av. Engenheiro Luís Carlos Berrini
null

number

Title: Number
Description: The store address number
Type: string or null
Example:
105
null

additional

Title: Additional
Description: The store additional address information
Type: string or null
Example:
1th floor
some important address information
room b
null

neighborhood

Title: Neighborhood
Description: The store neighborhood
Type: string or null
Example:
Vila Olimpia
null

state

Title: State
Description: The store state
Type: string or null
Example:
SP
null

zip_code

Title: Zip code
Description: The store zip code
Type: string or null
Example:
12345-678
null

new_address required

Title: The store new address information
Type: object

main

Title: Main address
Description: The store address streat
Type: string or null
Example:
Av. Engenheiro Luís Carlos Berrini
null

number

Title: Number
Description: The store address number
Type: string or null
Example:
105
null

additional

Title: Additional
Description: The store additional address information
Type: string or null
Example:
1th floor
some important address information
room b
null

neighborhood

Title: Neighborhood
Description: The store neighborhood
Type: string or null
Example:
Vila Olimpia
null

state

Title: State
Description: The store state
Type: string or null
Example:
SP
null

zip_code

Title: Zip code
Description: The store zip code
Type: string or null
Example:
12345-678
null

{
    "type": "object",
    "title": "p2m store data updated",
    "required": [
        "method",
        "uri",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "Method",
            "description": "The HTTP Method of contract data change operation",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": [
                "string",
                "null"
            ],
            "title": "URI",
            "description": "The URI of contract data change operation",
            "examples": [
                "/v1/clientes/:merchantDocument/contratos/:contractCode",
                null
            ]
        },
        "email": {
            "type": [
                "string",
                "null"
            ],
            "title": "E-mail",
            "description": "The operator email of contract data change operation",
            "examples": [
                "[email protected]",
                null
            ]
        },
        "operator_profile": {
            "type": [
                "string",
                "null"
            ],
            "title": "Operator profile",
            "description": "The operator profile of contract data change operation",
            "examples": [
                "[email protected]",
                null
            ]
        },
        "object": {
            "type": "object",
            "title": "Object",
            "description": "The object that represents the store data change operation",
            "required": [
                "old_status",
                "new_status",
                "store_code",
                "merchant_document",
                "old_address",
                "new_address"
            ],
            "properties": {
                "old_status": {
                    "type": "string",
                    "title": "Old status",
                    "description": "The store old status",
                    "examples": [
                        "Ativo",
                        "Inativo"
                    ]
                },
                "new_status": {
                    "type": "string",
                    "title": "New status",
                    "description": "The store new status",
                    "examples": [
                        "Ativo",
                        "Inativo"
                    ]
                },
                "store_code": {
                    "type": "string",
                    "title": "Store code",
                    "description": "The store code identifier",
                    "examples": [
                        "000001"
                    ]
                },
                "merchant_document": {
                    "type": "string",
                    "title": "Merchant document",
                    "description": "The merchant reference document",
                    "examples": [
                        "99999999999999",
                        "99999999999"
                    ]
                },
                "old_address": {
                    "type": "object",
                    "title": "Old address",
                    "description": "The store old address information",
                    "properties": {
                        "main": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Main address",
                            "description": "The store address street",
                            "examples": [
                                "Av. Engenheiro Lu\u00eds Carlos Berrini",
                                null
                            ]
                        },
                        "number": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Number",
                            "description": "The store address number",
                            "examples": [
                                "105",
                                null
                            ]
                        },
                        "additional": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Additional",
                            "description": "The store additional address information",
                            "examples": [
                                "1th floor",
                                "some important address information",
                                "room b",
                                null
                            ]
                        },
                        "neighborhood": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Neighborhood",
                            "description": "The store neighborhood",
                            "examples": [
                                "Vila Olimpia",
                                null
                            ]
                        },
                        "state": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "State",
                            "description": "The store state",
                            "examples": [
                                "SP",
                                null
                            ]
                        },
                        "zip_code": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Zip code",
                            "description": "The store zip code",
                            "examples": [
                                "12345-678",
                                null
                            ]
                        }
                    }
                },
                "new_address": {
                    "type": "object",
                    "title": "The store new address information",
                    "properties": {
                        "main": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Main address",
                            "description": "The store address streat",
                            "examples": [
                                "Av. Engenheiro Lu\u00eds Carlos Berrini",
                                null
                            ]
                        },
                        "number": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Number",
                            "description": "The store address number",
                            "examples": [
                                "105",
                                null
                            ]
                        },
                        "additional": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Additional",
                            "description": "The store additional address information",
                            "examples": [
                                "1th floor",
                                "some important address information",
                                "room b",
                                null
                            ]
                        },
                        "neighborhood": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Neighborhood",
                            "description": "The store neighborhood",
                            "examples": [
                                "Vila Olimpia",
                                null
                            ]
                        },
                        "state": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "State",
                            "description": "The store state",
                            "examples": [
                                "SP",
                                null
                            ]
                        },
                        "zip_code": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Zip code",
                            "description": "The store zip code",
                            "examples": [
                                "12345-678",
                                null
                            ]
                        }
                    }
                }
            }
        }
    }
}
{
    "method": "POST",
    "uri": "/v1/clientes/:merchantDocument/contratos/:contractCode",
    "email": "[email protected]",
    "operator_profile": "[email protected]",
    "object": {
        "old_status": "Ativo",
        "new_status": "Ativo",
        "store_code": "000001",
        "merchant_document": "99999999999999",
        "old_address": {
            "main": "Av. Engenheiro Lu\u00eds Carlos Berrini",
            "number": "105",
            "additional": "1th floor",
            "neighborhood": "Vila Olimpia",
            "state": "SP",
            "zip_code": "12345-678"
        },
        "new_address": {
            "main": "Av. Engenheiro Lu\u00eds Carlos Berrini",
            "number": "105",
            "additional": "1th floor",
            "neighborhood": "Vila Olimpia",
            "state": "SP",
            "zip_code": "12345-678"
        }
    }
}