Yordex

Managing trader relations

In this tutorial you will learn how to get the details of your relation with another trader

To keep this tutorial simple, not all functionality is described on this page. For an overview of all functionality, please read our API reference.

To find out what your relation is to another trader, you should call this API

curl https://api.yordex.com/v1/relations?traderId=other-trader-id
-H "Authorization:your-api-key"  
-X GET

The response will look as follows.

{
  "id" : "relation-id",
  "approved" : false,
  "traderId" : "other-trader-id",
  "traderForm": {
    "key" : "value"
  },
  "approverUserId": "user-id",
  "ownerUserId": "user-id"
}

A relation will only exist if you created this other trader.

In this example, the trader is not yet approved. If the trader is approved, the approved field will be true.

The traderForm field is a free form object that you can use to store any data about this relation. For example, you can use it to store the id under which this other trader is known in your systems or you can store information from your custom supplier boarding form.

The ownerUserId and approverUserId are fields used by us to approve this trader.

Full details of the Relations API can be found in our API reference.

Updated 2 years ago


Managing trader relations


In this tutorial you will learn how to get the details of your relation with another trader

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.