List orders (admin)

GET

/admin/orders

Authorization

headerx-api-key<token>

Organization-scoped API key with scope metadata.

Query Parameters

page?integer

Range0 < value <= 9007199254740991

perPage?integer

Range0 < value <= 200

status?string

customerId?string

dateFrom?string

dateTo?string

search?string

awaitingPaymentFrom?string

queue?string

open: not fulfilled or cancelled yet. to_fulfill: open, paid and not shipped.

Value in"open""to_fulfill"

sortField?string

Value in"createdAt""total"

sortDirection?string

Value in"asc""desc"

Response Body

Success

application/json

response

items*array<>

total*number

page*number

perPage*number

hasMore*boolean

Example Request

curl -X GET 'https://api-prood.vercel.app/v1/admin/orders'

Example Request

curl -X GET 'https://api-prood.vercel.app/v1/admin/orders'

Example ResponseSchema

{
  "items": [
    {
      "id": "string",
      "orderNumber": "string",
      "status": "placed",
      "paymentStatus": "unpaid",
      "fulfillmentStatus": "unfulfilled",
      "items": [
        {
          "id": "string",
          "productId": "string",
          "variantId": "string",
          "name": {
            "property1": "string",
            "property2": "string"
          },
          "variantName": {
            "property1": "string",
            "property2": "string"
          },
          "image": {
            "url": "string",
            "alt": "string",
            "width": 0,
            "height": 0
          },
          "quantity": 0,
          "price": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "totalPrice": {
            "amount": 0,
            "currency": "string",
            "formatted": "string"
          },
          "fulfillmentStatus": "unfulfilled",
          "productType": "physical"
        }
      ],
      "totals": {
        "subtotal": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "shipping": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "discount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "total": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        }
      },
      "shippingAddress": {
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "street": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      },
      "billingAddress": {
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "street": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      },
      "shippingMethod": {
        "id": "string",
        "name": {
          "property1": "string",
          "property2": "string"
        },
        "provider": "string",
        "fulfillmentType": "shipping",
        "estimatedDays": {
          "min": 0,
          "max": 0
        },
        "price": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "cashOnDelivery": true
      },
      "paymentMethod": {
        "id": "string",
        "type": "string",
        "name": {
          "property1": "string",
          "property2": "string"
        },
        "provider": "string",
        "installments": {
          "count": 0,
          "amount": 0,
          "currency": "string"
        },
        "icon": "string"
      },
      "paymentProvider": "string",
      "paymentTransactionId": "string",
      "paymentDetails": {
        "method": "card",
        "entity": "string",
        "reference": "string",
        "expiresAt": "string"
      },
      "couponCode": "string",
      "trackingNumber": "string",
      "trackingUrl": "string",
      "note": "string",
      "customerId": "string",
      "contactEmail": "string",
      "requiresShipping": true,
      "placedAt": "string",
      "approvedAt": "string",
      "cancelledAt": "string",
      "fulfilledAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "perPage": 0,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "orderNumber": "string",      "status": "placed",      "paymentStatus": "unpaid",      "fulfillmentStatus": "unfulfilled",      "items": [        {          "id": "string",          "productId": "string",          "variantId": "string",          "name": {            "property1": "string",            "property2": "string"          },          "variantName": {            "property1": "string",            "property2": "string"          },          "image": {            "url": "string",            "alt": "string",            "width": 0,            "height": 0          },          "quantity": 0,          "price": {            "amount": 0,            "currency": "string",            "formatted": "string"          },          "totalPrice": {            "amount": 0,            "currency": "string",            "formatted": "string"          },          "fulfillmentStatus": "unfulfilled",          "productType": "physical"        }      ],      "totals": {        "subtotal": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "shipping": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "tax": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "discount": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "total": {          "amount": 0,          "currency": "string",          "formatted": "string"        }      },      "shippingAddress": {        "firstName": "string",        "lastName": "string",        "phone": "string",        "street": "string",        "street2": "string",        "city": "string",        "state": "string",        "country": "string",        "postalCode": "string"      },      "billingAddress": {        "firstName": "string",        "lastName": "string",        "phone": "string",        "street": "string",        "street2": "string",        "city": "string",        "state": "string",        "country": "string",        "postalCode": "string"      },      "shippingMethod": {        "id": "string",        "name": {          "property1": "string",          "property2": "string"        },        "provider": "string",        "fulfillmentType": "shipping",        "estimatedDays": {          "min": 0,          "max": 0        },        "price": {          "amount": 0,          "currency": "string",          "formatted": "string"        },        "cashOnDelivery": true      },      "paymentMethod": {        "id": "string",        "type": "string",        "name": {          "property1": "string",          "property2": "string"        },        "provider": "string",        "installments": {          "count": 0,          "amount": 0,          "currency": "string"        },        "icon": "string"      },      "paymentProvider": "string",      "paymentTransactionId": "string",      "paymentDetails": {        "method": "card",        "entity": "string",        "reference": "string",        "expiresAt": "string"      },      "couponCode": "string",      "trackingNumber": "string",      "trackingUrl": "string",      "note": "string",      "customerId": "string",      "contactEmail": "string",      "requiresShipping": true,      "placedAt": "string",      "approvedAt": "string",      "cancelledAt": "string",      "fulfilledAt": "string",      "createdAt": "string",      "updatedAt": "string"    }  ],  "total": 0,  "page": 0,  "perPage": 0,  "hasMore": true}

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body