Jump to

• Request
• Response

Import a B2B Document

post

/ic/api/b2b/v1/b2bdocuments/import

Imports a B2B Document with its associated schemas from the previously exported document zip file.

Request

Query Parameters

• isOverwrite(required): boolean

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

  Example:

  /b2b/v1/b2bdocuments/import?isOverwrite=true

  Default Value: false

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file: string (binary)
  Previously exported Document ZIP file.

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"Previously exported Document ZIP file.",
            "format":"binary"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : ImportDocRs

Match All

Show Source

• object GenericRestRs
• object ImportDocRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "required":[
                "documents",
                "schemas"
            ],
            "type":"object",
            "properties":{
                "documents":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
                    }
                },
                "schemas":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : ImportDocRs-allOf[1]

Type: object

Show Source

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

{
    "required":[
        "documents",
        "schemas"
    ],
    "type":"object",
    "properties":{
        "documents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
            }
        },
        "schemas":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
            }
        }
    }
}

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 ImportDocRs.ImportDocStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
    }
}

Nested Schema : schemas

Type: array

Show Source

• Array of: object ImportDocRs.ImportDocStatus

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus"
    }
}

Nested Schema : ImportDocRs.ImportDocStatus

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

500 Response

Server error

Back to Top