Skip to content
Products
/
/
/
TL03 - Export transaction...

TL03 - Export transaction lines JSON file asynchronously

Request

Description

The export is asynchronous. Export status can be retrieved by calling TL04.

Call Frequency
Recommended usage:
once per day
Maximum usage:
once per day
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ACCOUNTANCY
ROLE_PARTNER_TRANSACTION_LOG_REA...
)
Query
shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
accounting_document_idstring

Accounting document request id. This parameter filters on documents requests with these entity types: SHOP_BILLING_CYCLE_PURCHASE_ORDER, FEES or ONE_OFF_FEES.

accounting_document_numberstring

Accounting document number

date_created_fromstring, (date-time)

Creation date

date_created_tostring, (date-time)

Creation date

formatstring

The format of the exported file in TL05. Default value JSON.

Enum: "JSON", "NDJSON"

items_per_chunkinteger, (int64)

The maximum number of items per chunk.

last_updated_fromstring, (date-time)

Last updated date

megabytes_per_chunkinteger, (int64)

The maximum size in megabytes of a chunk.

order_idArray of strings, [ 0 .. 100 ] items

Order id. This parameter can be supplied multiple times.

order_line_idArray of strings, [ 0 .. 100 ] items

Order line id. This parameter can be supplied multiple times.

order_reference_for_customerArray of strings, [ 0 .. 100 ] items

A comma-separated list of order references for customer.

order_reference_for_sellerArray of strings, [ 0 .. 100 ] items

A comma-separated list of order references for seller.

other_referenceArray of strings, [ 0 .. 100 ] items

An external reference for one-off transactions that are not tied to a Mirakl order. This parameter can be supplied multiple times.

pay_out_psp_codesArray of strings

A comma-separated list of pay-out PSP codes. This parameter requires the Hybrid pay-out PSP feature to be enabled.

payment_stateArray of strings, [ 0 .. 100 ] items

Payment state. This parameter can be supplied multiple times.

payment_voucher_numberstring

Payment voucher

seller_billing_cycle_idArray of strings, [ 0 .. 100 ] items

Seller billing cycle ID (UUID format). This parameter can be supplied multiple times.

shop_domainArray of strings, [ 0 .. 100 ] items

A shop domain. This parameter can be supplied multiple times.

shop_idinteger, (int64)

Shop identifier

shop_modelArray of strings

Shop model. This parameter can be supplied multiple times.

transaction_date_fromstring, (date-time)

Transaction date

transaction_date_tostring, (date-time)

Transaction date

transaction_typeArray of strings, [ 0 .. 100 ] items

Transaction type. This parameter can be supplied multiple times.

curl -i -X POST \
  'https://your-instance.mirakl.net/api/sellerpayment/transactions_logs/async?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "Transaction_date_from": "2021-11-12T02:34:00Z",
    "megabytes_per_chunk": "10",
    "shop_domain": [
      "PRODUCT"
    ],
    "transaction_type": [
      "MANUAL_CREDIT"
    ]
  }'

Responses

OK

Bodyapplication/json
tracking_idstring

The asynchronous transaction log export id

Response
{
  "tracking_id": "2c31b6de-ac53-410a-a3dc-2974f9b1e4e4"
}