Jump to

• Request
• Response

Retrieve a Trading Partner

get

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

Retrieves a trading partner with the specified trading partner ID.

Request

Path Parameters

• tpId(required): string

  Trading partner ID.

  Example:

  /b2b/v1/tpm/partners/TP123

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "inboundAgreementCount":{
                    "type":"integer"
                },
                "outboundAgreementCount":{
                    "type":"integer"
                },
                "tags":{
                    "$ref":"#/components/schemas/Tags"
                },
                "createdBy":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "updatedBy":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "inboundActiveAgreementCount":{
                    "type":"integer"
                },
                "outboundActiveAgreementCount":{
                    "type":"integer"
                },
                "deployedTransportCount":{
                    "type":"integer"
                },
                "activatedTransportIntgCount":{
                    "type":"integer"
                }
            }
        }
    ]
}

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

Type: object

Show Source

• links: array links

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

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

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

Nested Schema : type

Type: object

Show Source

• activatedTransportIntgCount: integer
• createdBy: string
• createdDate: string
• deployedTransportCount: integer
• desc: string
• id: string
• inboundActiveAgreementCount: integer
• inboundAgreementCount: integer
• name: string
• outboundActiveAgreementCount: integer
• outboundAgreementCount: integer
• status: string
• tags: object Tags
• updatedBy: string
• updatedDate: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "inboundAgreementCount":{
            "type":"integer"
        },
        "outboundAgreementCount":{
            "type":"integer"
        },
        "tags":{
            "$ref":"#/components/schemas/Tags"
        },
        "createdBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "inboundActiveAgreementCount":{
            "type":"integer"
        },
        "outboundActiveAgreementCount":{
            "type":"integer"
        },
        "deployedTransportCount":{
            "type":"integer"
        },
        "activatedTransportIntgCount":{
            "type":"integer"
        }
    }
}

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

Type: object

Show Source

• tag: array tag
  Gets the value of the tag property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the tag property. For example, to add a new item, do as follows: getTag().add(newItem); Objects of the following type(s) are allowed in the list String

{
    "type":"object",
    "properties":{
        "tag":{
            "type":"array",
            "description":"Gets the value of the tag property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the tag property.\n \n \n For example, to add a new item, do as follows:\n \n    getTag().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n String",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : tag

Type: array

Gets the value of the tag property. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the tag property. For example, to add a new item, do as follows: getTag().add(newItem); Objects of the following type(s) are allowed in the list String

Show Source

• Array of: string

{
    "type":"array",
    "description":"Gets the value of the tag property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the tag property.\n \n \n For example, to add a new item, do as follows:\n \n    getTag().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n String",
    "items":{
        "type":"string"
    }
}

404 Response

Not found

500 Response

Server error

Back to Top