Skip to content
On this page

Fetch Unfulfillment ​

Retrieve the checkout data of unfulfilled orders from your store. These are checkouts that a customer started but did not finish.

Each item in results holds only the checkout data: customer, shipping, discount, details, note and method.

Endpoint ​

GET /api/datasets/unfulfillment

Query Parameters ​

NameTypeDescription
pageintPage number (optional, default 1)
limitintItems per page (optional, default 20)
field3stringStatus of the checkout (optional, default pending)

TIP

When field3 is not sent, only pending checkouts are returned.

Example ​

GET https://api-stores.storeino.com/api/datasets/unfulfillment?page=1&limit=5

Response ​

json
{
  "results": [
    {
      "customer": {
        "firstname": "string",
        "lastname": "string",
        "fullname": "string",
        "email": "string",
        "phone": "string",
        "ipAddress": "string",
        "address": {
          "address1": "string",
          "address2": "string",
          "country": { "_id": "string", "name": "string" },
          "province": { "_id": "string", "name": "string" },
          "city": { "_id": "string", "name": "string" }
        }
      },
      "shipping": {
        "zone": null,
        "shipper": null,
        "price": 0,
        "address": {
          "address1": "string",
          "address2": "string",
          "country": { "_id": "string", "name": "string" },
          "province": { "_id": "string", "name": "string" },
          "city": { "_id": "string", "name": "string" }
        }
      },
      "discount": null,
      "details": [],
      "customerNote": "string",
      "method": null
    }
  ],
  "paginate": {
    "total": 1,
    "per_page": 5,
    "current_page": 1,
    "last_page": 1
  }
}

Released under the MIT License.