🪵Fields & Events
Retrieves a list of event logs, optionally filtered by subscription ID and supports pagination.
Query parameters
pageinteger · int32Optional
Page number of the event log pagination.
limitinteger · int32Optional
Number of event logs per page.
subscriptionIdstringOptional
Filter event logs by subscription ID.
Responses
200
A list of event logs.
application/json
totalintegerOptional
Total number of event logs matching the query.
500
Internal Server Error
application/json
get/event-log/
GET /event-log/ HTTP/1.1
Host: localhost:3002
Accept: */*
{
"logs": [
{
"subscriptionId": "text",
"message": "text",
"eventType": "Create",
"userId": "SYSTEM",
"details": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"timestamp": "2026-01-01T00:00:00.000Z",
"shop": "text"
}
],
"total": 1
}Retrieves a list of field options for various parameters used in the system.
Responses
200
A list of field options.
application/json
billingIntervalstring[]OptionalExample:
["DAY","MONTH","WEEK","YEAR"]billingAnchorTypestring[]OptionalExample:
["WEEKDAY","MONTHDAY","YEARDAY"]deliveryIntervalstring[]OptionalExample:
["DAY","MONTH","WEEK","YEAR"]intentstring[]OptionalExample:
["FULFILLMENT_BEGIN"]preAnchorBehaviorstring[]OptionalExample:
["ASAP","NEXT"]deliveryAnchorTypestring[]OptionalExample:
["WEEKDAY","MONTHDAY","YEARDAY"]pricingPolicyTypestring[]OptionalExample:
["fixed","recurring"]adjustmentTypestring[]OptionalExample:
["FIXED_AMOUNT","PERCENTAGE","PRICE"]currencyCodestring[]OptionalExample:
["USD","EUR","GBP"]statusstring[]OptionalExample:
["ACTIVE","CANCELLED","EXPIRED","FAILED","PAUSED"]400
Bad Request - Errors in fetching field options.
application/json
get/fields/
GET /fields/ HTTP/1.1
Host: localhost:3002
Accept: */*
{
"billingInterval": [
"DAY",
"MONTH",
"WEEK",
"YEAR"
],
"billingAnchorType": [
"WEEKDAY",
"MONTHDAY",
"YEARDAY"
],
"deliveryInterval": [
"DAY",
"MONTH",
"WEEK",
"YEAR"
],
"intent": [
"FULFILLMENT_BEGIN"
],
"preAnchorBehavior": [
"ASAP",
"NEXT"
],
"deliveryAnchorType": [
"WEEKDAY",
"MONTHDAY",
"YEARDAY"
],
"pricingPolicyType": [
"fixed",
"recurring"
],
"adjustmentType": [
"FIXED_AMOUNT",
"PERCENTAGE",
"PRICE"
],
"currencyCode": [
"USD",
"EUR",
"GBP"
],
"status": [
"ACTIVE",
"CANCELLED",
"EXPIRED",
"FAILED",
"PAUSED"
]
}Last updated