Ctrl+K

List Trading Partners

get/api/trade/v1/enterprise/{enterpriseId}/account/{accountId}/tradingpartners

The List Trading Partners API gets the trading partners for the given trading account.

Path Parameters

  • enterpriseIdstringRequired
    Enterprise ID
  • accountIdstringRequired
    Trading Account ID

Query Parameters

  • statusstring
    Status of trading partner relationship
    Example: accepted
    Enum: accepted rejected canceled pending unknown

200 Response

tradingPartners array[object]
Example: {"id":"456ed60d-3fd7-4463-88ba-1e489a48c530","primaryEnterpriseName":"Trading Partner Co.","primaryAccountId":"585cf0c85573c3a8416ac85f","secondaryEnterpriseName":"Requester Co.","secondaryAccountId":"585ci0c855g3c3a8416ac85g","status":"accepted","type":"direct","updatedAt":"2019-05-03T00:37:49.196Z","requesterAccountId":"585ci0c855g3c3a8416ac85g"}
id string <uuid>
unique ID of the trading partnership, used for updating partnerships
primaryAccountId string
primary account ID of the partnership
primaryEnterpriseName string
enterprise name of the primary account ID
secondaryAccountId string
secondary account ID of the partnership
secondaryEnterpriseName string
enterprise name of the secondary account ID
status string
Partnership status between two trading accounts
Allowed values: accepted rejected canceled pending unknown
Example: accepted
type string
Partnership type between two trading accounts
Allowed values: direct agency
Example: direct
updatedAt string <date-time>
ISO date string
requesterAccountId string
account ID that initiated the trading partner request

400 Response

error string required
Human-readable error message
errorName string required
Immutable error code for API integration
reqId string required
Client request id