Class OrderService

constructor

• new OrderService(httpRequest): OrderService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns OrderService

ReadonlyhttpRequest

cancelOrder

• cancelOrder(nonce, requestBody?): CancelablePromise<CancelOrderResponse>

• Parameters

  • nonce: string

    nonce of the order
  • OptionalrequestBody: CancelOrderRequest

    Signature of the request

  Returns CancelablePromise<CancelOrderResponse>

  CancelOrderResponse successful operation

  Deprecated

  Cancel an offchain order. Deprecated since cancelling should always be done onchain even for offchain orders. To cancel an order, call the zeroEx contract appropriate function.

  Throws

  ApiError

createOrder

• createOrder(requestBody?): CancelablePromise<Order>

• Add an off chain NFT order in the orderbook. Add an order in the orderbook. This order can be filled by anyone. Offchain orders are not compatible with smart wallets, including Cometh connect.

  The order needs to be signed by the maker before it is passed.

  For onchain orders, use the preSignERC721Order method of the 0x contract.

  Parameters

  • OptionalrequestBody: NewOrder

    Store a Signed order in the orderbook

  Returns CancelablePromise<Order>

  Order successful operation

  Throws

  ApiError

getOffersReceivedByAddress

• getOffersReceivedByAddress(userAddress, limit?, skip?): CancelablePromise<PaginatedOrders>

• Get offers received by an address Returns a list of purchase offers received by the given Ethereum address. The result includes pagination.

  Parameters

  • userAddress: string

    The Ethereum address of the user.
  • Optionallimit: number
  • Optionalskip: number

  Returns CancelablePromise<PaginatedOrders>

  PaginatedOrders Success

  Throws

  ApiError

getOffersSentByAddress

• getOffersSentByAddress(userAddress, limit?, skip?): CancelablePromise<PaginatedOrders>

• Get offers sent by an address Returns a list of purchase offers sent by the given Ethereum address. The result includes pagination.

  Parameters

  • userAddress: string

    The Ethereum address of the user.
  • Optionallimit: number
  • Optionalskip: number

  Returns CancelablePromise<PaginatedOrders>

  PaginatedOrders Success

  Throws

  ApiError

prepareFill

• prepareFill(maker, nonce, requestBody?): CancelablePromise<PrepareFillResponse>

• Prepare order filling Prepare the 0x order payload to be passed in the buyERC721 or sellERC721 smart contract function.

  Parameters

  • maker: string

    maker of the order
  • nonce: string

    nonce of the order
  • OptionalrequestBody: PrepareFillRequest

  Returns CancelablePromise<PrepareFillResponse>

  PrepareFillResponse successful operation

  Throws

  ApiError

prepareListing

• prepareListing(requestBody?): CancelablePromise<PrepareListingResponse>

• Prepare order listing Prepare the 0x order payload to be signed by the end-customer and passed in the preSignERC721Order smart contract function. This order can be filled by anyone.

  Parameters

  • OptionalrequestBody: PrepareListingRequest

  Returns CancelablePromise<PrepareListingResponse>

  PrepareListingResponse successful operation

  Throws

  ApiError

searchOrderFilledEvents

• searchOrderFilledEvents(requestBody?): CancelablePromise<PaginatedFilledEvents>

• Search ERC1155 NFT orders filled events from the orderbook Combine all filters as AND conditions to search for filled events. ERC1155 orders can be partially filled in several transactions each emitting a filled event.

  Parameters

  • OptionalrequestBody: SearchFilledEventsRequest

    Body of orders search

  Returns CancelablePromise<PaginatedFilledEvents>

  PaginatedFilledEvents List of matching filled events

  Throws

  ApiError

searchOrders

• searchOrders(requestBody?): CancelablePromise<PaginatedOrders>

• Search NFT orders from the orderbook Combine all filters as AND conditions to search for orders.

  Parameters

  • OptionalrequestBody: SearchOrdersRequest

    Body of orders search

  Returns CancelablePromise<PaginatedOrders>

  PaginatedOrders List of matching orders

  Throws

  ApiError