Jump to

• Request
• Response

Create/Update B2B Identifiers

post

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

Add a new or update existing B2B identifier 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

• identifierUI: IdentifiersRs

{
    "type":"object",
    "properties":{
        "identifierUI":{
            "$ref":"#/components/schemas/IdentifiersRs"
        }
    }
}

Nested Schema : IdentifiersRs

Match All

Show Source

• object GenericRestRs
• object IdentifiersRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "supported_identifiers_types":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : IdentifiersRs-allOf[1]

Type: object

Show Source

• items: array items
• supported_identifiers_types: array supported_identifiers_types

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "supported_identifiers_types":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions"
            }
        }
    }
}

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: IdentifierRs

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

Nested Schema : supported_identifiers_types

Type: array

Show Source

• Array of: object IdentifiersRs.IdentifierSuggestions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions"
    }
}

Nested Schema : IdentifierRs

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "identifierType":{
                    "type":"string"
                },
                "identifierValue":{
                    "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 : IdentifierRs-allOf[2]

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string

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

Nested Schema : IdentifiersRs.IdentifierSuggestions

Type: object

Show Source

• desc: string
• label: string
• type: string

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : IdentifiersRs

Match All

Show Source

• object GenericRestRs
• object IdentifiersRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "supported_identifiers_types":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : IdentifiersRs-allOf[1]

Type: object

Show Source

• items: array items
• supported_identifiers_types: array supported_identifiers_types

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "supported_identifiers_types":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions"
            }
        }
    }
}

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: IdentifierRs

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

Nested Schema : supported_identifiers_types

Type: array

Show Source

• Array of: object IdentifiersRs.IdentifierSuggestions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions"
    }
}

Nested Schema : IdentifierRs

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "identifierType":{
                    "type":"string"
                },
                "identifierValue":{
                    "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 : IdentifierRs-allOf[2]

Type: object

Show Source

• id: string
• identifierType: string
• identifierValue: string

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

Nested Schema : IdentifiersRs.IdentifierSuggestions

Type: object

Show Source

• desc: string
• label: string
• type: string

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        }
    }
}

409 Response

Duplicate data error

412 Response

Pre-condition failure

500 Response

Server error

Back to Top