API Reference

This endpoint is used to:

  • Create a new listing
  • Change price of an existing listing
  • Create a new offer or collection offer

Follow the Generate order payload guide to generate content of the order parameter.

📘

Important

Before creating offers, the owner must approve the item's transfer on the X2Y2 ERC-721 Delegate or X2Y2 ERC-1155 Delegate with the setApprovalForAll function on the item's contract.

📘

Price limitation

Order price must be no less than 0.0001 ETH and not more than 100000000 ETH.

Body Params
string
required

An order payload that contains the order info.

boolean
required
Defaults to false

Must be false.

orderIds
array of int32s
required

Empty array for new listing. OrderId of the current order when change its price.

orderIds*
boolean
required
Defaults to false

Set to true only when changing the price of an existing listing

boolean
required
Defaults to false

Set to true only when creating a new collection offer

boolean
Defaults to false

Set to true to create an private listing. Must be used together with taker

string
Defaults to null

Must be used with isPrivate: true. Specifies who could buy the private listing.

Responses

Language
Credentials
Choose an example:
application/json