Email send log (offset pagination; optional status/type/order filters)

GET

/admin/v1/emails

const url = 'https://your-store.example.com/admin/v1/emails?status=sent&type=order_confirmation&page=1&pageSize=20';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://your-store.example.com/admin/v1/emails?status=sent&type=order_confirmation&page=1&pageSize=20'

Parameters

Query Parameters

status

string

Allowed values: sent failed

type

string

Allowed values: order_confirmation order_shipped refund_issued

orderId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

page

integer

default: 1 >= 1 <= 9007199254740991

pageSize

integer

default: 20 >= 1 <= 200

Email send log (offset pagination; optional status/type/order filters)

Parameters

Query Parameters

Responses

200