Jump to

• Request
• Response

Delete a Trading Partner

delete

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

Deletes a trading partner with the specified trading partner id.

Request

Path Parameters

• tpId: string
  Trading partner ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : TradingPartnerRs

Type: object

Show Source

• createdBy(optional): string
• createdDate(optional): string
• desc(optional): string
• id(optional): string
• inboundActiveAgreementCount(optional): integer
• inboundAgreementCount(optional): integer
• links(optional): array links
• name(optional): string
• outboundActiveAgreementCount(optional): integer
• outboundAgreementCount(optional): integer
• status(optional): string
• tags(optional): object Tags
• updatedBy(optional): string
• updatedDate(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "inboundAgreementCount":{
            "type":"integer"
        },
        "inboundActiveAgreementCount":{
            "type":"integer"
        },
        "outboundActiveAgreementCount":{
            "type":"integer"
        },
        "tags":{
            "$ref":"#/definitions/Tags"
        },
        "createdBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "outboundAgreementCount":{
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : Tags

Type: object

Show Source

• tag(optional): array tag

{
    "type":"object",
    "properties":{
        "tag":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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"
        }
    }
}

Nested Schema : tag

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Not found

500 Response

Server error

Back to Top