List Checkouts - Documentação DEVMOB

List Checkouts

curl --request GET \
  --url https://api.example.com/api/v1/customer/checkouts

{
  "data": [
    {
      "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "amount": 123,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 142,
    "totalPages": 15
  }
}

GET

api

customer

checkouts

List Checkouts

curl --request GET \
  --url https://api.example.com/api/v1/customer/checkouts

{
  "data": [
    {
      "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "amount": 123,
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 142,
    "totalPages": 15
  }
}

Query Parameters

limit

number

default:10

Items per page.

Required range: 1 <= x <= 100

page

number

default:1

Page number.

Required range: x >= 1

createdAt

string

Created date range.

sortBy

enum<string>

default:createdAt

Field to sort by.

Available options:

createdAt,

amount

sortOrder

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

fields

string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

data

object[]

required

Show child attributes