These docs are for v2.0. Click to read the latest docs for v3.0.

Get Fulfillments

List all fulfillments.

🚧
The Market API will be discontinued, in Q3 2024 we will be sunsetting this product

1. Get all fulfillments

Request Endpoint: reference

GET /fulfillments

Example Requests:

GET https://api.venly.market/fulfillments?buyerId=67682a06-bbab-4b2e-a885-76dc4a7130a3&status=COMPLETED&type=PURCHASE&pageNumber=1&pageSize=2

Response Body:

{
  "success": true,
  "result": [
    {
      "id": "80a7cb15-e15f-4c2d-8190-3ce4d59bc1fa",
      "type": "PURCHASE",
      "offerId": "42591755-dd33-484b-8eb4-6bbffd9855d8",
      "txOutOfCustody": "0xac42415fdc51bafee50ff68f06e325e8dab30017bd187152411a14841aa4a074",
      "amount": 1,
      "status": "COMPLETED",
      "creationDate": "2022-01-11T09:52:57.844130",
      "pricePerItem": 11,
      "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
      "buyer": {
        "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
      }
    },
    {
      "id": "c5e3f3fd-bcc0-4bb5-8f00-3ab4c1bd6b2d",
      "type": "PURCHASE",
      "offerId": "1e539137-178e-4f00-bb48-396759f9733e",
      "txOutOfCustody": "0x54692a05441b01e777017abf453aa0e8256c5e60f2e3b076f9417c1d0d9cfe3c",
      "amount": 1,
      "status": "COMPLETED",
      "creationDate": "2022-01-19T15:35:28.700647",
      "pricePerItem": 12,
      "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
      "buyer": {
        "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
      }
    },
    {
      "id": "5705223e-e8cf-4cb7-ba18-a909d992d578",
      "type": "PURCHASE",
      "offerId": "97545019-b50f-486f-8188-65b95022fe2f",
      "txOutOfCustody": "0xecd0b28f6fc0e3e4d07a141ac63a02781cdd57ac6b2c1594a79f69e84f8c4107",
      "amount": 1,
      "status": "COMPLETED",
      "creationDate": "2022-02-15T09:35:35.048815",
      "pricePerItem": 15,
      "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
      "buyer": {
        "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
      }
    }
  ]
}

2. Get fulfillment by `id`

Request Endpoint: reference

GET /fulfillments/{id}

Parameter	Param Type	Description	Data Type	Mandatory
`id`	Path	The fulfillment `ID`	String	✅

Example Requests:

GET https://api.venly.market/80a7cb15-e15f-4c2d-8190-3ce4d59bc1f

Response Body:

{
  "success": true,
  "result": {
    "id": "80a7cb15-e15f-4c2d-8190-3ce4d59bc1fa",
    "type": "PURCHASE",
    "offerId": "42591755-dd33-484b-8eb4-6bbffd9855d8",
    "txOutOfCustody": "0xac42415fdc51bafee50ff68f06e325e8dab30017bd187152411a14841aa4a074",
    "amount": 1,
    "status": "COMPLETED",
    "creationDate": "2022-01-11T09:52:57.844130",
    "pricePerItem": 11,
    "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
    "buyer": {
      "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
    }
  }
}

3. Get user fulfillments

This endpoint returns all the fulfillments (offers bought and offers put on sale) and filters the response body.

Request Endpoint: reference

GET /user/fulfillments

Example Request:

GET https://api.venly.market/user/fulfillments?isBuyer=true&status=COMPLETED&type=PURCHASE&pageNumber=1&pageSize=2

Response Body:

{
  "success": true,
  "result": [
    {
      "id": "80a7cb15-e15f-4c2d-8190-3ce4d59bc1fa",
      "type": "PURCHASE",
      "offerId": "42591755-dd33-484b-8eb4-6bbffd9855d8",
      "txOutOfCustody": "0xac42415fdc51bafee50ff68f06e325e8dab30017bd187152411a14841aa4a074",
      "amount": 1,
      "status": "COMPLETED",
      "creationDate": "2022-01-11T09:52:57.844130",
      "pricePerItem": 11,
      "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
      "buyer": {
        "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
      }
    },
    {
      "id": "c5e3f3fd-bcc0-4bb5-8f00-3ab4c1bd6b2d",
      "type": "PURCHASE",
      "offerId": "1e539137-178e-4f00-bb48-396759f9733e",
      "txOutOfCustody": "0x54692a05441b01e777017abf453aa0e8256c5e60f2e3b076f9417c1d0d9cfe3c",
      "amount": 1,
      "status": "COMPLETED",
      "creationDate": "2022-01-19T15:35:28.700647",
      "pricePerItem": 12,
      "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
      "buyer": {
        "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
      }
    },
    {
      "id": "5705223e-e8cf-4cb7-ba18-a909d992d578",
      "type": "PURCHASE",
      "offerId": "97545019-b50f-486f-8188-65b95022fe2f",
      "txOutOfCustody": "0xecd0b28f6fc0e3e4d07a141ac63a02781cdd57ac6b2c1594a79f69e84f8c4107",
      "amount": 1,
      "status": "COMPLETED",
      "creationDate": "2022-02-15T09:35:35.048815",
      "pricePerItem": 15,
      "buyerId": "67682a06-bbab-4b2e-a885-76dc4a7130a3",
      "buyer": {
        "id": "67682a06-bbab-4b2e-a885-76dc4a7130a3"
      }
    }
  ]
}

Updated 10 months ago

Did this page help you?