ChangelogGuidesRecipesAPI ReferenceRoadmap
HomeGuidesRecipesAPI ReferenceChangelog
ChangelogGuidesRecipesAPI ReferenceRoadmapSTART FREE TRIALSCHEDULE A DEMO
API Reference
START FREE TRIALSCHEDULE A DEMO
Start typing to search…

Request export

post
https://www.pelcro.com/api/v1/core/exports

Request an export to start processing in the background.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string
required

Type of the object being exported. Allowed values can be retrieved through the List Exports endpoint

date-time
required

Start date on which the data for the export is needed. This is based on the relevant object's created_at date.

date-time
required

End date on which the data for the export is needed. This is based on the relevant object's created_at date.

string
enum
Defaults to full_data

Specifies whether a full or modified data extract is needed. Use full_data to extract all data within the given date range based on the created_at attribute of the object, or modified_data to extract based on the updated_at attribute.

Allowed:
date
required

Date on which the data for the export is needed. This is based on the relevant object's date. Applicable to the following Exports: (accounting).

string

Currency used for financial transactions. Applicable to the following Exports: (payments, credit_notes, accounting).

string

Status relevant to the applicable object. Applicable to the following Exports: (subscriptions, memberships, invoices, payments, refunds, orders).

int32

Object ID relevant to the applicable objects. Applicable to the following Exports: (campaign_reports).

int32

Product ID relevant to the applicable objects. Applicable to the following Exports: (subscriptions, memberships, orders).

int32

Plan ID relevant to the applicable objects. Applicable to the following Exports: (subscriptions, memberships).

int32

SKU ID relevant to the applicable objects. Applicable to the following Exports: (orders).

string

Payment collection option relevant to the applicable objects. Applicable to the following Exports: (subscriptions, memberships).

string

Object type relevant to the applicable objects. Applicable to the following Exports: (payments, refunds, addresses, balance_transactions).

string

Object category relevant to the applicable objects. Applicable to the following Exports: (payments)

string

Object destination relevant to the applicable objects. Applicable to the following Exports: (payments)

string

Object reason relevant to the applicable objects. Applicable to the following Exports: (credit_notes)

string

Country ISO-2 codes relevant to applicable objects. Applicable to the following Exports: (addresses)

string

Campaign key relevant to the applicable objects. Applicable to the following Exports: (campaign_reports).

Headers
string
required
Defaults to Bearer eyJ***
Responses

Updated about 7 hours ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 7 hours ago