Jump to

• Request
• Response

Import a Trading Partner

post

/ic/api/b2b/v1/tpm/partners/import

Imports a trading partner with the associated agreements, documents, schemas, and host identifiers from the previously exported trading partner zip file.

Request

Query Parameters

• isOverwrite(required): boolean

  Overwrite flag to overwrite components in the zip file. Default value is false.

  Example:

  ic/api/b2b/v1/tpm/partners/import?isOverwrite=true

  Default Value: false

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : ImportTPRs

Match All

Show Source

• object GenericRestRs
• object ImportTPRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "required":[
                "documents",
                "hostIdentifiers",
                "schemas"
            ],
            "type":"object",
            "properties":{
                "tradingPartner":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
                    }
                },
                "documents":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
                    }
                },
                "schemas":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
                    }
                },
                "hostIdentifiers":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : ImportTPRs-allOf[1]

Type: object

Show Source

• documents(required): array documents
• hostIdentifiers(required): array hostIdentifiers
• schemas(required): array schemas
• tradingPartner: array tradingPartner

{
    "required":[
        "documents",
        "hostIdentifiers",
        "schemas"
    ],
    "type":"object",
    "properties":{
        "tradingPartner":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
            }
        },
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
            }
        },
        "schemas":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
            }
        },
        "hostIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
            }
        }
    }
}

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

Type: array

Show Source

• Array of: object ImportTPRs.ImportStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
    }
}

Nested Schema : hostIdentifiers

Type: array

Show Source

• Array of: object ImportTPRs.ImportStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
    }
}

Nested Schema : schemas

Type: array

Show Source

• Array of: object ImportTPRs.ImportStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
    }
}

Nested Schema : tradingPartner

Type: array

Show Source

• Array of: object ImportTPRs.ImportStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportTPRs.ImportStatus"
    }
}

Nested Schema : ImportTPRs.ImportStatus

Type: object

Show Source

• id(required): string
• name(required): string
• status(required): string

{
    "required":[
        "id",
        "name",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

404 Response

Not found

409 Response

Duplicate data error

412 Response

Pre-condition failure

500 Response

Server error

Back to Top