Create listing

POST

/v2/marketplace/{marketplaceId}/listing

• Staging
• Development

Create a new listing in a marketplace.

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Path Parameters

marketplaceId

required

string

The ID of the marketplace

Example

77a0049c-7683-45ff-956f-656f257048f7

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Request Body ^required

object

title

required

The title of the listing

string

Digital Art Collection

description

required

The description of the listing

string

A collection of unique digital artworks

assetIds

required

Array of asset IDs

Array<string>

[
  "asset-1",
  "asset-2",
  "asset-3"
]

state

The state of the listing

string

Allowed values: listed delisted sold locked locked.payment.initiated locked.payment.deposited

listed

status

The status of the listing

string

Allowed values: active inactive

active

paymentId

The unique ID for the payment

string

123e4567-e89b-12d3-a456-426614174000

assetSigningWalletId

required

The asset signing wallet ID

string

wallet-123

userId

The user ID

string

123e4567-e89b-12d3-a456-426614174000

organisationId

The organisation ID

string

123e4567-e89b-12d3-a456-426614174000

createdAt

The creation date

string

2024-01-01T00:00:00.000Z

updatedAt

The last update date

string

2024-01-01T00:00:00.000Z

acceptedPaymentMethods

required

Accepted payment methods

Array<object>

object

providerPaymethodId

required

The provider paymethod ID

string

paymethod-123

amount

required

The amount

string

100.00

currencyFiat

The fiat currency

string

USD

currencyContractDeploymentId

The contract deployment ID

string

contract-123

receiverAccounts

required

Receiver accounts

Array<object>

object

receiverAccountId

The receiver account ID

string

account-123

paymethodId

required

The paymethod ID

string

paymethod-123

listingId

The unique ID for the listing

string format: uuid

123e4567-e89b-12d3-a456-426614174000

Responses

201

The created listing details.

object

title

required

The title of the listing

string

Digital Art Collection

description

required

The description of the listing

string

A collection of unique digital artworks

assetIds

required

Array of asset IDs

Array<string>

[
  "asset-1",
  "asset-2",
  "asset-3"
]

state

The state of the listing

string

Allowed values: listed delisted sold locked locked.payment.initiated locked.payment.deposited

listed

status

The status of the listing

string

Allowed values: active inactive

active

paymentId

The unique ID for the payment

string

123e4567-e89b-12d3-a456-426614174000

assetSigningWalletId

required

The asset signing wallet ID

string

wallet-123

userId

The user ID

string

123e4567-e89b-12d3-a456-426614174000

organisationId

The organisation ID

string

123e4567-e89b-12d3-a456-426614174000

createdAt

The creation date

string

2024-01-01T00:00:00.000Z

updatedAt

The last update date

string

2024-01-01T00:00:00.000Z

acceptedPaymentMethods

required

Accepted payment methods

Array<object>

object

providerPaymethodId

required

The provider paymethod ID

string

paymethod-123

amount

required

The amount

string

100.00

currencyFiat

The fiat currency

string

USD

currencyContractDeploymentId

The contract deployment ID

string

contract-123

receiverAccounts

required

Receiver accounts

Array<object>

object

receiverAccountId

The receiver account ID

string

account-123

paymethodId

required

The paymethod ID

string

paymethod-123

marketplaceId

required

The ID of the marketplace

string

123e4567-e89b-12d3-a456-426614174000

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error