Get a trade account request

GET

/trade-applications/{id}

const url = 'https://example.com/trade-applications/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/trade-applications/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

sessionCookie
customers:read
apiKey
customers:read

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

200

The request

application/json

object

required

UUID v7

string format: uuid

status

required

string

Allowed values: pending approved declined

businessName

required

string

phone

required

string

companyNumber

required

string | null

vatNumber

required

string | null

contacts

required

Array<object> | null

object

name

required

string

role

required

string

Allowed values: buyer accounts

email

string

phone

string

address

required

object

line1

string

<= 120 characters

line2

string

<= 120 characters

city

string

<= 80 characters

postcode

string

<= 10 characters

notes

required

string | null

account

required

object

required

UUID v7

string format: uuid

email

required

string

name

required

string

customerId

required

UUID v7

string | null format: uuid

reason

required

string | null

decidedAt

required

string | null format: date-time

createdAt

required

string format: date-time

Example

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "status": "pending",
  "contacts": [
    {
      "role": "buyer"
    }
  ],
  "account": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  },
  "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

No such request, customer or sign-in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}