Jump to

• Request
• Response

Create/Update Trading Partner Contacts

post

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

Add new contact or update existing contact details with the specified trading partner id.

Request

Supported Media Types

• application/json

Path Parameters

• tpId: string
  Trading partner ID.

Body ()

Update trading partner contacts request details.

Example:

{ "contacts" : [{ "type": "firstName", "value": "John"}]}

Root Schema : ContactsRs

Type: object

Show Source

• items(optional): array items
• links(optional): array links

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

Nested Schema : items

Type: array

Show Source

• Array of: object ContactRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : ContactRs

Type: object

Show Source

• contactType(optional): string
• contactValue(optional): string
• id(optional): string
• links(optional): array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contactType":{
            "type":"string"
        },
        "contactValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ContactsRs

Type: object

Show Source

• items(optional): array items
• links(optional): array links

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

Nested Schema : items

Type: array

Show Source

• Array of: object ContactRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : ContactRs

Type: object

Show Source

• contactType(optional): string
• contactValue(optional): string
• id(optional): string
• links(optional): array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "contactType":{
            "type":"string"
        },
        "contactValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

201 Response

Successful operation

412 Response

Pre condition failure

500 Response

Server error

Back to Top