Jump to

• Request
• Response

Retrieve Trading Partners

get

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

Retrieve all available trading partners.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : tradingPartners

Type: object

Show Source

• items: array items
• links: array links
• size: integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TradingPartnerRs"
            }
        },
        "size":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    },
    "xml":{
        "name":"tradingPartners"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object TradingPartnerRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : TradingPartnerRs

Type: object

Show Source

• createdBy: string
• createdDate: string
• desc: string
• id: string
• inboundActiveAgreementCount: integer
• inboundAgreementCount: integer
• links: array links
• 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"
        },
        "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: array tag

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: 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