Jump to

• Request
• Response

Create/Update Trading Partner Contacts

post

/ic/api/b2b/v1/tpm/partners/{tpId}/contacts

Adda a new contact or update an existing contact details with the specified trading partner ID.

Request

Path Parameters

• tpId(required): string
  Trading partner ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• contactUI: ContactsRs

{
    "type":"object",
    "properties":{
        "contactUI":{
            "$ref":"#/components/schemas/ContactsRs"
        }
    }
}

Nested Schema : ContactsRs

Match All

Show Source

• object GenericRestRs
• object ContactsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ContactRs"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : ContactsRs-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactRs"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ContactRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactRs"
    }
}

Nested Schema : ContactRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object ContactRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "contactType":{
                    "type":"string"
                },
                "contactValue":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ContactRs-allOf[2]

Type: object

Show Source

• contactType: string
• contactValue: string
• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contactType":{
            "type":"string"
        },
        "contactValue":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : ContactsRs

Match All

Show Source

• object GenericRestRs
• object ContactsRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ContactRs"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : ContactsRs-allOf[1]

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactRs"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: ContactRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactRs"
    }
}

Nested Schema : ContactRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object ContactRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "contactType":{
                    "type":"string"
                },
                "contactValue":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ContactRs-allOf[2]

Type: object

Show Source

• contactType: string
• contactValue: string
• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contactType":{
            "type":"string"
        },
        "contactValue":{
            "type":"string"
        }
    }
}

412 Response

Pre-condition failure

500 Response

Server error

Back to Top