Jump to

• Request
• Response

createOrganizationRequest

post

/ccadmin/v1/webhook/createOrganizationRequest

The details of organization request created on the Oracle Commerce Cloud. The request includes profile and organization details

Request

Supported Media Types

• application/json

Body ()

Root Schema : createOrganizationRequest_request

Type: object

Show Source

• organizationRequest(optional): object organizationRequest

{
    "properties":{
        "organizationRequest":{
            "properties":{
                "approverComments":{
                    "description":"Org request approver comments",
                    "type":"string"
                },
                "relatedOrganizationName":{
                    "description":"Requester organization name.",
                    "type":"string"
                },
                "profile":{
                    "description":"Profile",
                    "type":"object",
                    "properties":{
                        "lastName":{
                            "description":"Last name of the profile",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"first name of the profile",
                            "type":"string"
                        },
                        "customerContactId":{
                            "description":"The external customer contact id.",
                            "type":"string"
                        },
                        "id":{
                            "description":"Repository Id of the profile",
                            "type":"string"
                        },
                        "email":{
                            "description":"emailid of profile",
                            "type":"string"
                        }
                    }
                },
                "organization":{
                    "description":"Organization",
                    "properties":{
                        "customerType":{
                            "description":"Customer Type for Organization",
                            "type":"string"
                        },
                        "taxReferenceNumber":{
                            "description":"taxReferenceNumberof organization",
                            "type":"string"
                        },
                        "secondaryAddressesIsTruncated":{
                            "description":"This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present",
                            "type":"boolean"
                        },
                        "name":{
                            "description":"The name for Organization",
                            "type":"string"
                        },
                        "secondaryAddresses":{
                            "description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "address":{
                                        "description":"Address created for the Organization.",
                                        "type":"object",
                                        "properties":{
                                            "country":{
                                                "description":"The country of the address",
                                                "type":"string"
                                            },
                                            "phoneNumber":{
                                                "description":"Phone Number of the address",
                                                "type":"string"
                                            },
                                            "address2":{
                                                "description":"The address2 of the secondary address",
                                                "type":"string"
                                            },
                                            "city":{
                                                "description":"The city of the secondary address",
                                                "type":"string"
                                            },
                                            "address1":{
                                                "description":"The address1 of the secondary address",
                                                "type":"string"
                                            },
                                            "companyName":{
                                                "description":"Company name of the secondary address",
                                                "type":"string"
                                            },
                                            "postalCode":{
                                                "description":"Postal Code of the address",
                                                "type":"string"
                                            },
                                            "repositoryId":{
                                                "description":"repository Id of the address",
                                                "type":"string"
                                            },
                                            "state":{
                                                "description":"The State of the address",
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "addressType":{
                                        "description":"Address type represents nick name of account if present else repository ID of address item.",
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "id":{
                            "description":"Repository Id of the Organization",
                            "type":"string"
                        },
                        "type":{
                            "description":"Type of Organization",
                            "type":"string"
                        },
                        "vatReferenceNumber":{
                            "description":"Vat reference number for the organization",
                            "type":"string"
                        },
                        "dunsNumber":{
                            "description":"dunsNumber of organization",
                            "type":"string"
                        },
                        "uniqueId":{
                            "description":"Unique Id of the Organization",
                            "type":"string"
                        }
                    }
                },
                "name":{
                    "description":"Organization request name given by the requester",
                    "type":"string"
                },
                "createdTime":{
                    "format":"date-time",
                    "description":"The date the account request was created",
                    "type":"string"
                },
                "siteId":{
                    "description":"Site id captured during request creation",
                    "type":"string"
                },
                "id":{
                    "description":"Id of Organization Request",
                    "type":"string"
                },
                "requesterComments":{
                    "description":"Requester comments given at time of creating request",
                    "type":"string"
                },
                "status":{
                    "description":"Status of Organization Request",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : organizationRequest

Type: object

Show Source

• approverComments(optional): string
  Org request approver comments
• createdTime(optional): string(date-time)
  The date the account request was created
• id(optional): string
  Id of Organization Request
• name(optional): string
  Organization request name given by the requester
• organization(optional): object organization
  Organization
• profile(optional): object profile
  Profile
• relatedOrganizationName(optional): string
  Requester organization name.
• requesterComments(optional): string
  Requester comments given at time of creating request
• siteId(optional): string
  Site id captured during request creation
• status(optional): string
  Status of Organization Request

{
    "properties":{
        "approverComments":{
            "description":"Org request approver comments",
            "type":"string"
        },
        "relatedOrganizationName":{
            "description":"Requester organization name.",
            "type":"string"
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "firstName":{
                    "description":"first name of the profile",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the profile",
                    "type":"string"
                },
                "email":{
                    "description":"emailid of profile",
                    "type":"string"
                }
            }
        },
        "organization":{
            "description":"Organization",
            "properties":{
                "customerType":{
                    "description":"Customer Type for Organization",
                    "type":"string"
                },
                "taxReferenceNumber":{
                    "description":"taxReferenceNumberof organization",
                    "type":"string"
                },
                "secondaryAddressesIsTruncated":{
                    "description":"This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present",
                    "type":"boolean"
                },
                "name":{
                    "description":"The name for Organization",
                    "type":"string"
                },
                "secondaryAddresses":{
                    "description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "address":{
                                "description":"Address created for the Organization.",
                                "type":"object",
                                "properties":{
                                    "country":{
                                        "description":"The country of the address",
                                        "type":"string"
                                    },
                                    "phoneNumber":{
                                        "description":"Phone Number of the address",
                                        "type":"string"
                                    },
                                    "address2":{
                                        "description":"The address2 of the secondary address",
                                        "type":"string"
                                    },
                                    "city":{
                                        "description":"The city of the secondary address",
                                        "type":"string"
                                    },
                                    "address1":{
                                        "description":"The address1 of the secondary address",
                                        "type":"string"
                                    },
                                    "companyName":{
                                        "description":"Company name of the secondary address",
                                        "type":"string"
                                    },
                                    "postalCode":{
                                        "description":"Postal Code of the address",
                                        "type":"string"
                                    },
                                    "repositoryId":{
                                        "description":"repository Id of the address",
                                        "type":"string"
                                    },
                                    "state":{
                                        "description":"The State of the address",
                                        "type":"string"
                                    }
                                }
                            },
                            "addressType":{
                                "description":"Address type represents nick name of account if present else repository ID of address item.",
                                "type":"string"
                            }
                        }
                    }
                },
                "id":{
                    "description":"Repository Id of the Organization",
                    "type":"string"
                },
                "type":{
                    "description":"Type of Organization",
                    "type":"string"
                },
                "vatReferenceNumber":{
                    "description":"Vat reference number for the organization",
                    "type":"string"
                },
                "dunsNumber":{
                    "description":"dunsNumber of organization",
                    "type":"string"
                },
                "uniqueId":{
                    "description":"Unique Id of the Organization",
                    "type":"string"
                }
            }
        },
        "name":{
            "description":"Organization request name given by the requester",
            "type":"string"
        },
        "createdTime":{
            "format":"date-time",
            "description":"The date the account request was created",
            "type":"string"
        },
        "siteId":{
            "description":"Site id captured during request creation",
            "type":"string"
        },
        "id":{
            "description":"Id of Organization Request",
            "type":"string"
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        },
        "status":{
            "description":"Status of Organization Request",
            "type":"string"
        }
    }
}

Nested Schema : organization

Type: object

Organization

Show Source

• customerType(optional): string
  Customer Type for Organization
• dunsNumber(optional): string
  dunsNumber of organization
• id(optional): string
  Repository Id of the Organization
• name(optional): string
  The name for Organization
• secondaryAddresses(optional): array secondaryAddresses
  Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
• secondaryAddressesIsTruncated(optional): boolean
  This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present
• taxReferenceNumber(optional): string
  taxReferenceNumberof organization
• type(optional): string
  Type of Organization
• uniqueId(optional): string
  Unique Id of the Organization
• vatReferenceNumber(optional): string
  Vat reference number for the organization

{
    "description":"Organization",
    "properties":{
        "customerType":{
            "description":"Customer Type for Organization",
            "type":"string"
        },
        "taxReferenceNumber":{
            "description":"taxReferenceNumberof organization",
            "type":"string"
        },
        "secondaryAddressesIsTruncated":{
            "description":"This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present",
            "type":"boolean"
        },
        "name":{
            "description":"The name for Organization",
            "type":"string"
        },
        "secondaryAddresses":{
            "description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "address":{
                        "description":"Address created for the Organization.",
                        "type":"object",
                        "properties":{
                            "country":{
                                "description":"The country of the address",
                                "type":"string"
                            },
                            "phoneNumber":{
                                "description":"Phone Number of the address",
                                "type":"string"
                            },
                            "address2":{
                                "description":"The address2 of the secondary address",
                                "type":"string"
                            },
                            "city":{
                                "description":"The city of the secondary address",
                                "type":"string"
                            },
                            "address1":{
                                "description":"The address1 of the secondary address",
                                "type":"string"
                            },
                            "companyName":{
                                "description":"Company name of the secondary address",
                                "type":"string"
                            },
                            "postalCode":{
                                "description":"Postal Code of the address",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"repository Id of the address",
                                "type":"string"
                            },
                            "state":{
                                "description":"The State of the address",
                                "type":"string"
                            }
                        }
                    },
                    "addressType":{
                        "description":"Address type represents nick name of account if present else repository ID of address item.",
                        "type":"string"
                    }
                }
            }
        },
        "id":{
            "description":"Repository Id of the Organization",
            "type":"string"
        },
        "type":{
            "description":"Type of Organization",
            "type":"string"
        },
        "vatReferenceNumber":{
            "description":"Vat reference number for the organization",
            "type":"string"
        },
        "dunsNumber":{
            "description":"dunsNumber of organization",
            "type":"string"
        },
        "uniqueId":{
            "description":"Unique Id of the Organization",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Profile

Show Source

• customerContactId(optional): string
  The external customer contact id.
• email(optional): string
  emailid of profile
• firstName(optional): string
  first name of the profile
• id(optional): string
  Repository Id of the profile
• lastName(optional): string
  Last name of the profile

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "firstName":{
            "description":"first name of the profile",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the profile",
            "type":"string"
        },
        "email":{
            "description":"emailid of profile",
            "type":"string"
        }
    }
}

Nested Schema : secondaryAddresses

Type: array

Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook

Show Source

• Array of: object items

{
    "description":"Address associated with an Organization request, this is the address provided by the requestor at the time of request creation. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "address":{
                "description":"Address created for the Organization.",
                "type":"object",
                "properties":{
                    "country":{
                        "description":"The country of the address",
                        "type":"string"
                    },
                    "phoneNumber":{
                        "description":"Phone Number of the address",
                        "type":"string"
                    },
                    "address2":{
                        "description":"The address2 of the secondary address",
                        "type":"string"
                    },
                    "city":{
                        "description":"The city of the secondary address",
                        "type":"string"
                    },
                    "address1":{
                        "description":"The address1 of the secondary address",
                        "type":"string"
                    },
                    "companyName":{
                        "description":"Company name of the secondary address",
                        "type":"string"
                    },
                    "postalCode":{
                        "description":"Postal Code of the address",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"repository Id of the address",
                        "type":"string"
                    },
                    "state":{
                        "description":"The State of the address",
                        "type":"string"
                    }
                }
            },
            "addressType":{
                "description":"Address type represents nick name of account if present else repository ID of address item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address(optional): object address
  Address created for the Organization.
• addressType(optional): string
  Address type represents nick name of account if present else repository ID of address item.

{
    "type":"object",
    "properties":{
        "address":{
            "description":"Address created for the Organization.",
            "type":"object",
            "properties":{
                "country":{
                    "description":"The country of the address",
                    "type":"string"
                },
                "phoneNumber":{
                    "description":"Phone Number of the address",
                    "type":"string"
                },
                "address2":{
                    "description":"The address2 of the secondary address",
                    "type":"string"
                },
                "city":{
                    "description":"The city of the secondary address",
                    "type":"string"
                },
                "address1":{
                    "description":"The address1 of the secondary address",
                    "type":"string"
                },
                "companyName":{
                    "description":"Company name of the secondary address",
                    "type":"string"
                },
                "postalCode":{
                    "description":"Postal Code of the address",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"repository Id of the address",
                    "type":"string"
                },
                "state":{
                    "description":"The State of the address",
                    "type":"string"
                }
            }
        },
        "addressType":{
            "description":"Address type represents nick name of account if present else repository ID of address item.",
            "type":"string"
        }
    }
}

Nested Schema : address

Type: object

Address created for the Organization.

Show Source

• address1(optional): string
  The address1 of the secondary address
• address2(optional): string
  The address2 of the secondary address
• city(optional): string
  The city of the secondary address
• companyName(optional): string
  Company name of the secondary address
• country(optional): string
  The country of the address
• phoneNumber(optional): string
  Phone Number of the address
• postalCode(optional): string
  Postal Code of the address
• repositoryId(optional): string
  repository Id of the address
• state(optional): string
  The State of the address

{
    "description":"Address created for the Organization.",
    "type":"object",
    "properties":{
        "country":{
            "description":"The country of the address",
            "type":"string"
        },
        "phoneNumber":{
            "description":"Phone Number of the address",
            "type":"string"
        },
        "address2":{
            "description":"The address2 of the secondary address",
            "type":"string"
        },
        "city":{
            "description":"The city of the secondary address",
            "type":"string"
        },
        "address1":{
            "description":"The address1 of the secondary address",
            "type":"string"
        },
        "companyName":{
            "description":"Company name of the secondary address",
            "type":"string"
        },
        "postalCode":{
            "description":"Postal Code of the address",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository Id of the address",
            "type":"string"
        },
        "state":{
            "description":"The State of the address",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top