🪵Fields & Events

Fetch event logs

Retrieves a list of event logs, optionally filtered by subscription ID and supports pagination.

GEThttp://localhost:3002/event-log/

Query parameters

Response

200500

A list of event logs.

Body

application/json

logsarray of EventLog (object)

totalinteger

Total number of event logs matching the query.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/event-log/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "logs": [
    {
      "subscriptionId": "text",
      "message": "text",
      "eventType": "Create",
      "userId": "SYSTEM",
      "timestamp": "2024-11-21T09:17:24.279Z",
      "shop": "text"
    }
  ]
}

Fetch field options

Retrieves a list of field options for various parameters used in the system.

GEThttp://localhost:3002/fields/

Response

200400

A list of field options.

Body

application/json

billingIntervalarray of string

billingAnchorTypearray of string

deliveryIntervalarray of string

intentarray of string

preAnchorBehaviorarray of string

deliveryAnchorTypearray of string

pricingPolicyTypearray of string

adjustmentTypearray of string

currencyCodearray of string

statusarray of string

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:3002/fields/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "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"
  ]
}