List accounting documents requests

Mirakl Marketplace APIs (latest-release)

Servers

URL to be replaced by your Mirakl instance URL

https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

List accounting documents requests

Request

Query

idstring

Filter document requests with the given id

document_numberstring

Filter document requests with the given document number

date_created_fromstring(date-time)

Filter document requests created after the given date

date_created_tostring(date-time)

Filter document requests created before the given date

last_updated_fromstring(date-time)

Filter document requests updated after the given date

last_updated_tostring(date-time)

Filter document requests updated before the given date

issue_date_fromstring(date-time)

Filter document requests issued after the given date

issue_date_tostring(date-time)

Filter document requests issued before the given date

stateArray of strings[ 0 .. 100 ] items

Document request states. This parameter can be supplied multiple times.

typeArray of strings[ 0 .. 100 ] items

Accounting document types. This parameter can be supplied multiple times.

issuer_typeArray of strings[ 0 .. 100 ] items

Issuer types. This parameter can be supplied multiple times.

entity_idArray of strings[ 0 .. 100 ] items

Entity identifiers. (default: include all). This parameter can be supplied multiple times.
The entity_type must be specified to use this filter, otherwise an error 400 will be returned.
Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER

entity_typeArray of strings[ 0 .. 100 ] items

Entity types. This parameter can be supplied multiple times.

billing_cycle_fromstring(date-time)

Filter document requests generated by billing cycle after the given date. This filter is only available for documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER.

billing_cycle_tostring(date-time)

Filter document requests generated by billing cycle before the given date. This filter is only available for documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER.

payment_statestring

Filter document requests with the given payment state. This filter is only available for documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER, LOGISTIC_PURCHASE_ORDER.

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.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/document-request/requests?billing_cycle_from=2019-08-24T14%3A15%3A22Z&billing_cycle_to=2019-08-24T14%3A15%3A22Z&date_created_from=2019-08-24T14%3A15%3A22Z&date_created_to=2019-08-24T14%3A15%3A22Z&document_number=string&entity_id=string&entity_type=string&id=string&issue_date_from=2019-08-24T14%3A15%3A22Z&issue_date_to=2019-08-24T14%3A15%3A22Z&issuer_type=string&last_updated_from=2019-08-24T14%3A15%3A22Z&last_updated_to=2019-08-24T14%3A15%3A22Z&page_token=string&payment_state=string&shop_id=0&sort=string&state=string&type=string'

Responses

Bodyapplication/json

dataArray of objects(DR11_Response_200_Data)

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

application/json

{
  "data": [
    { … }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

List of document request lines

Request

Path

document_request_idstringrequired

Document Request identifier

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.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/document-request/{document_request_id}/lines?page_token=string&shop_id=0&sort=string'

Responses

Bodyapplication/json

dataArray of objects(DR12_Response_200_Data)

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

application/json

{
  "data": [
    { … }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

Download accounting documents

Request

At least one of the following filters must be applied: document_id or entity_id
If more than one document is requested, the output of the API will be a ZIP archive.
The tree structure of this archive is as follows:

 documents-1624624030618.zip | |__ product-logistic-order/ |   |order1-A/|      | INV203837.pdf |      |__ INV203837.cxml |   |order1-B/|      | INV203839.pdf

Query

document_request_idArray of strings[ 0 .. 100 ] items

The document request unique identifier. This parameter can be supplied multiple times.

document_idArray of strings[ 0 .. 100 ] items

Document identifiers. This parameter can be supplied multiple times.

document_formatArray of strings[ 0 .. 100 ] items

Document formats. This parameter can be supplied multiple times.

entity_idArray of strings[ 0 .. 100 ] items

Entity identifiers related to the documents to download. This parameter can be supplied multiple times.
The entity_type must be specified to use this filter, otherwise an error 400 will be returned.
Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER

entity_typeArray of strings[ 0 .. 100 ] items

Entity types related to the documents to download. This parameter can be supplied multiple times.

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.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/document-request/documents/download?document_format=string&document_id=string&document_request_id=string&entity_id=string&entity_type=string&shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

List accounting documents

Request

Query

currencystring

Currency code for filtering

end_datestring(date-time)

Creation date for filtering

issuing_user_typesArray of strings

A comma separated list of issuing user type for filtering. By default all types are returned

pay_out_psp_codesArray of strings

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

payment_statusstring

Accounting document payment state

start_datestring(date-time)

Creation date for filtering

typestring

Accounting document type for filtering. By default only invoices by the shop payment process are returned.

Default "AUTO_INVOICE"

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.

maxinteger(int32)

Maximum number of items returned per page

offsetinteger(int32)

Index of the first item (among all the results) in the returned page

sortstring

How the results should be sorted

orderstring

Sort direction

curl -i -X GET \
  'https://your-instance.mirakl.net/api/invoices?currency=string&end_date=2019-08-24T14%3A15%3A22Z&issuing_user_types=string&max=0&offset=0&order=string&pay_out_psp_codes=string&payment_status=string&shop_id=0&sort=string&start_date=2019-08-24T14%3A15%3A22Z&type=AUTO_INVOICE'

Responses

Bodyapplication/json

invoicesArray of objects(IV01_Response_200_Invoices)

Accounting documents

total_countinteger(int64)

Accounting documents total count

Response

application/json

{
  "invoices": [
    { … }
  ],
  "total_count": 0
}

Download an accounting document

Request

Path

accounting_document_idinteger(int64)required

Accounting document identifier

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.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/invoices/{accounting_document_id}?shop_id=0'

Responses

Bodyapplication/octet-stream

string(binary)

List transaction lines

Request

This resource uses seek pagination. The maximum allowed value for parameter limit is 2000.

Query

date_created_fromstring(date-time)

Creation date for filtering

date_created_tostring(date-time)

Creation date for filtering

transaction_date_fromstring(date-time)

Transaction date for filtering

transaction_date_tostring(date-time)

Transaction date for filtering

last_updated_fromstring(date-time)

Last updated date for filtering

payment_stateArray of strings[ 0 .. 100 ] items

Payment state for filtering. This parameter can be supplied multiple times.

transaction_typeArray of strings[ 0 .. 100 ] items

Transaction type for filtering. This parameter can be supplied multiple times.

accounting_document_numberstring

Accounting document number for filtering.

order_idArray of strings[ 0 .. 100 ] items

Order id for filtering. This parameter can be supplied multiple times.

order_line_idArray of strings[ 0 .. 100 ] items

Order line id for filtering. 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.

accounting_document_idstring

Accounting document id for filtering. This parameter only filter documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER.

shop_modelArray of strings

Shop model for filtering. This parameter can be supplied multiple times.

pay_out_psp_codesArray of strings

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

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.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/sellerpayment/transactions_logs?accounting_document_id=string&accounting_document_number=string&date_created_from=2019-08-24T14%3A15%3A22Z&date_created_to=2019-08-24T14%3A15%3A22Z&last_updated_from=2019-08-24T14%3A15%3A22Z&order_id=string&order_line_id=string&order_reference_for_customer=string&order_reference_for_seller=string&page_token=string&pay_out_psp_codes=string&payment_state=string&shop_id=0&shop_model=string&sort=string&transaction_date_from=2019-08-24T14%3A15%3A22Z&transaction_date_to=2019-08-24T14%3A15%3A22Z&transaction_type=string'

Responses

Bodyapplication/json

dataArray of objects(TL02_Response_200_Data)

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

application/json

{
  "data": [
    { … }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

Export transaction lines JSON file asynchronously

Request

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

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 id for filtering. This parameter only filter documents requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER.

accounting_document_numberstring

Accounting document number for filtering.

date_created_fromstring(date-time)

Creation date for filtering

date_created_tostring(date-time)

Creation date for filtering

items_per_chunkinteger(int64)

The maximum number of items per chunk.

last_updated_fromstring(date-time)

Last updated date for filtering

megabytes_per_chunkinteger(int64)

The maximum size in megabytes of a chunk.

order_idArray of strings[ 0 .. 100 ] items

Order id for filtering. This parameter can be supplied multiple times.

order_line_idArray of strings[ 0 .. 100 ] items

Order line id for filtering. 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.

pay_out_psp_codesArray of strings

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

payment_stateArray of strings[ 0 .. 100 ] items

Payment state for filtering. This parameter can be supplied multiple times.

payment_voucher_numberstring

Payment voucher for filtering

shop_domainArray of strings[ 0 .. 100 ] items

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

shop_idinteger(int64)

Shop identifier

shop_modelArray of strings

Shop model for filtering. This parameter can be supplied multiple times.

transaction_date_fromstring(date-time)

Transaction date for filtering

transaction_date_tostring(date-time)

Transaction date for filtering

transaction_typeArray of strings[ 0 .. 100 ] items

Transaction type for filtering. 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 'Content-Type: application/json' \
  -d '{
    "accounting_document_id": "string",
    "accounting_document_number": "string",
    "date_created_from": "2019-08-24T14:15:22Z",
    "date_created_to": "2019-08-24T14:15:22Z",
    "items_per_chunk": 0,
    "last_updated_from": "2019-08-24T14:15:22Z",
    "megabytes_per_chunk": 0,
    "order_id": [
      "string"
    ],
    "order_line_id": [
      "string"
    ],
    "order_reference_for_customer": [
      "string"
    ],
    "order_reference_for_seller": [
      "string"
    ],
    "pay_out_psp_codes": [
      "string"
    ],
    "payment_state": [
      "string"
    ],
    "payment_voucher_number": "string",
    "shop_domain": [
      "string"
    ],
    "shop_id": 0,
    "shop_model": [
      "string"
    ],
    "transaction_date_from": "2019-08-24T14:15:22Z",
    "transaction_date_to": "2019-08-24T14:15:22Z",
    "transaction_type": [
      "string"
    ]
  }'

Responses

Bodyapplication/json

tracking_idstring

The asynchronous transaction log export id

Response

application/json

{
  "tracking_id": "string"
}

Poll the status of an asynchronous transaction log export (TL03)

Request

Retrieve the status for an TL03 transaction log export.
When the export is complete, the URLs to retrieve the files are returned.

Path

tracking_idstringrequired

The asynchronous transaction log export id

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.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/sellerpayment/transactions_logs/async/status/{tracking_id}?shop_id=0'

Responses

Bodyapplication/json

errorobject(TL04_Response_200_Error)

last_updatedstring(date-time)

The last updated date of the export

statusstring

Current status of the export, can be 'PENDING', 'FAILED', 'CANCELED', or 'COMPLETED'

urlsArray of strings

List of generated urls to call to download each generated chunks

Response

application/json

{
  "error": {
    "code": "string",
    "detail": "string"
  },
  "last_updated": "2019-08-24T14:15:22Z",
  "status": "string",
  "urls": [
    "string"
  ]
}

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations