GuidesAPI Reference
Log In
API Reference

List UDF Definitions

Returns a paginated list of UDF definitions.

Deferred Execution

This endpoint supports deferred (asynchronous) execution for large result sets. When enabled, the API queues the request and returns HTTP 202 with a request_id. Results are streamed to S3 and made available via presigned URL.

Query Parameters

  • is_async (boolean): Set to true to enable asynchronous processing.
  • callback_url (string): Optional HTTPS URL to receive completion notifications. The payload contains request_id, status, and data_url (when available).
  • callback_secret (string): Optional secret for HMAC signature verification. Only used when callback_url is provided.

Callback Signature Verification

When callback_secret is provided, deferred callbacks include HMAC signature headers so the receiver can authenticate the sender. The callback request includes X-ERC-Callback-Timestamp and X-ERC-Callback-Signature headers; receivers should verify the signature before trusting the payload.

The signature is HMAC-SHA256 over <timestamp>.<canonical_body> where canonical_body is JSON serialized with stable key ordering and no extra whitespace (equivalent to Python: json.dumps(payload, separators=(',', ':'), sort_keys=True)). Do not compute the HMAC over the raw HTTP body.

Workflow

  1. Submit request with is_async=true
  2. Receive HTTP 202 with request_id
  3. Poll Check Deferred Execution Status API or wait for callback
  4. Download results from presigned data_url
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional secret used to sign callback requests.

uri
length ≥ 1

Optional HTTPS callback URL for deferred execution completion notifications.

date-time

Filter upon the create date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

integer
enum

Target entity type (Product or Item)

  • 1 - Product
  • 2 - Item (Reserved)
  • 3 - Supplier
  • 4 - Customer
Allowed:
string
length ≥ 1

Assigned field name unique per entity

integer

The unique system assigned value that identifies this record.

boolean

Set to true to enable asynchronous processing.

integer

Maximum number of results per page. The default is 25.

string

Fields to order upon. Valid fields include: udf_definition_id, entity_type, uuid, field_name

integer

Page of results to retrieve

integer
enum

Determines storage location: Product (global Product.udf_data) or Item (store-specific Item.udf_data)

  • 1 - Product
  • 2 - Item
  • 3 - Supplier
  • 4 - Supplier Branch Relationship
  • 5 - Distinct for Jobs
  • 6 - Same for Jobs
Allowed:
integer

The unique system assigned value that identifies this record.

date-time

Filter upon the update date/time using ISO8601 format. Assumption is UTC unless TZ offset is specified.

uuid

Immutable UUID referenced within udf_data JSONB

Headers
integer
required

The id of the active store to be used for this API invocation

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json