Skip to main content

API log

The menu Data » API log contains a history of both internal processes and external processes that run via interfaces. There is an entry for every process.
This menu contains a general API log and 4 additional tabs. The SOAP log tab contains a record of who carried out which SOAP calls. It indicates when the calls were carried out and how. The SOAP statistics tab lists access data. The Amazon API log tab lists every Amazon log entry individually. Some entries contain more detailed information as well. If you click on the folder icon next to an Amazon entry in the API log tab, then you will also be redirected to the Amazon API log tab. The Shipping center API log tab contains information about shipments that were registered in the shipping center.

1. Filtering log entries

By default, entries are sorted in descending order by their ID. The entries can be filtered so that fewer search results are displayed in the list. You can filter entries with a specific API name or date.

Filtering log entries with a specific name:

  1. Go to Data » API log.

  2. Select a format from the drop-down list Process.

  3. Click on Search to carry out the search.

Format is not listed

The formats are not included in the Process drop-down list until the process has been carried out once and therefore has been logged. If a particular format is not included in the list, then it means that the process has not been carried out yet or that this particular error has not occurred.

Filtering log entries with a specific date:

  1. Go to Data » API log.

  2. Select a date from the calendar.

  3. Click on Search to carry out the search.

Of course, both filters can be used together if you only want to see the entries that have a specific API name and a specific date.

2. Process: Email

The Email process contains error messages that relate to emails, e.g. when emails cannot be sent or when email accounts or addresses are not configured correctly. The process is added to the drop-down list when such an error occurs for the first time. The following information is displayed in an error message, e.g. if an email could not be sent: customer ID, order ID and the provider’s error message. This information is also displayed in the log entry.

Event Explanation

Error sending email. CustomerId: 136 OrderId: 550 (Code 535): 5.7.8 Error: authentication failed: UGFzc3dvcmQ6

The email was not sent. The authentication failed due to incorrect parameters in the email account, e.g. an incorrect password or user name.

Error sending email. CustomerId: 153 OrderId: 103 (Code 0): stream_socket_client(): unable to connect to tcp://mail.servername.com:XXX (Connection refused)

The email was not sent due to an incorrect port entry. XXX = Port

3. DHL Fulfillment log entries

This chapter provides information about all of the log entries that relate to DHL Fulfillment. Information is transferred to DHL Fulfillment when some processes are carried out. There are 3 events for the entries that relate to such processes. There are also processes that query information from DHL Fulfillment. There is one event for such processes.

3.1. DHLFulfillment ItemMaster

This entry is recorded in the log when item master data is registered. The entry itself does not indicate whether the items were successfully transferred or not. There are 3 possible events for this entry. The events provide information about the exact status of the data transfer.

Event Explanation

Successfully transmitted ItemMaster

The item master data was transferred. A separate event indicates how many orders were correctly registered.

Could not transmit ItemMaster

The item master data was not transferred.

Count ItemMaster: xxx entries done and xxx errors!

Indicates the number of items that were transferred and the number of items that were not transferred.

3.2. DHLFulfillment DeliveryAdvice

This entry is recorded in the log when information is transferred. This information relates to reordered items that will be delivered soon. The entry itself does not indicate whether the information was successfully transferred or not. There are 3 possible events for this entry. The events provide information about the exact status of the data transfer. The Parameter column lists the reorder IDs.

Event Explanation

Successfully transmitted DeliveryAdvices!

The reorders were transferred. A separate event indicates how many reorders were correctly registered.

Could not transmit DeliveryAdvices

The reorders were not transferred.

Count DeliveryAdvice: xxx entries done and xxx errors!

Indicates the number of reorders that were registered and the number of reorders that were not registered.

3.3. DHLFulfillment DeliveryReceipt

This entry is recorded in the log when reorders are marked as delivered. There is 1 possible event for this entry. The event indicates how many reorders were marked as delivered. However, the information does not indicate whether the reorder was delivered in full. The reorder itself indicates which items were delivered.

Event Explanation

DHLFulfillment Delivery Receipt! Count Entries: xxx

The number of reorders that were marked as delivered.

3.4. DHLFulfillment StockAdjustment

This entry is recorded in the log when stock is adjusted. There is 1 possible event for this entry. The event indicates how many stock adjustments were made.

Event Explanation

Processed StockAdjustment! Count Entries: xxx

Number of stock adjustments.

3.5. DHLFulfillment Inventory

This entry is recorded in the log when the current stock is queried, i.e. when inventory is taken. There is 1 possible event for this entry. The event indicates how many stocks were synchronized.

Event Explanation

Processed Inventory! Count Entries: xxx

The number of items for which stock was synchronized.

3.6. DHLFulfillment Order

This entry is recorded in the log when orders are registered. There are 3 possible events for this entry. The events provide information about the exact status of the registration. The Parameter column lists the order IDs.

Event Explanation

Successfully transmitted Order!

The orders were transferred. A separate event indicates how many orders were correctly registered.

Could not transmit Orders

The orders were not transferred.

Count Order: xxx entries done and xxx errors!

Indicates the number of orders that were registered and the number of orders that were not registered.

If it was not possible to register an order and the registration process was carried out again, then plentymarkets will automatically change the order ID when the order is registered. This is because DHL Fulfillment only accepts an order ID once, even if the registration was not successful. Nonetheless, the Parameter column lists the correct order ID in plentymarkets. However, the file that is displayed in the Process column contains the ID that was used when registering the order with DHL Fulfillment.

3.7. DHLFulfillment Transport

This entry is recorded in the log when orders are sent. There is 1 possible event for this entry. The event indicates whether or not the order was sent. In some cases, an order is split into several delivery orders. This is the case if some items can be sent earlier than others or if an order is always shipped in multiple packages. The Parameter column lists the order IDs and delivery order IDs. If delivery orders were created, then a slash (/) is used to separate the delivery order from the order. For example, 1957/1956 means that a delivery order with the ID 1957 was created for an order with the ID 1956.

Event Explanation

Processed Transport! Count Entries: xxx, Count Errors: xxx

Count Entries = The number of orders that were sent.
Count Errors = The number of sent orders that could not be assigned to an order. There are several different reasons why this can happen. For example, if the order was not found in the system or if only some of the items were sent, i.e. if the order was not shipped in full. If only some of the items were shipped with DHL Fulfillment, then a delivery order will be created for the items that were already shipped.

3.8. DHLFulfillment OrderReturned

This entry is recorded in the log when returns are queried. There is 1 possible event for this entry. The event provides information about the returns that were queried. The Parameter column lists order IDs. These are the orders for which returns were created.

Event Explanation

Processed OrderReturned! Count Entries: xxx, Count Errors: xxx

Count Entries = The number of returns that were created in plentymarkets.
Count Errors = The number of queried DHL Fulfillment returns for which it was not possible to create a return in your system. There are many reasons why this can happen. For example, it may not have been possible to find the main order that the return was supposed to be created for. This could be because the main order was deleted, etc.

3.9. DHLFulfillment OrderCanceled

This entry is recorded in the log when cancellations are queried, i.e. when DHL Fulfillment cancels the order. There are many reasons why DHL Fulfillment may cancel an order. For example, if the items are incorrect. There is 1 possible event for this entry. The event provides information about the cancellations that were queried. The Parameter column lists order IDs. These are the orders for which cancellations were created in your system.

Event Explanation

Processed OrderCanceled! Count Entries: xxx, Count Errors: xxx

Count Entries = The number of cancellations that were created in plentymarkets.
Count Errors = The number of queried DHL Fulfillment cancellations for which it was not possible to create a cancellation in your system. There are many reasons why this can happen. For example, it may not have been possible to find the main order that the cancellation was supposed to be created for. This could be because the main order was deleted, etc.

4. atriga log entries

This chapter provides information about all of the log entries that relate to atriga and atrigapaymax.

4.1. atriga

The atriga log entries provide information about the products that were activated.

Parameter Explanation

atriga request

Request to atriga. This checks whether the product atrigapaymax was activated.

atriga response

Answer from atriga. This specifies whether atrigapaymax was activated.

4.2. atrigapaymax

The atrigapaymax log entries provide information about the credit rating.

Parameter Explanation

Atrigapaymax request

Request to atrigapaymax. This requests a credit rating.

Atrigapaymax response

Answer from atrigapaymax. This gives the results of the credit rating.
The response includes an error if the credit rating fails. If an error occurs, then a negative credit rating - red credit rating - will be displayed in the customer data record.

5. DPD Cloud Webservice log entries

This chapter provides information about the log entries that relate to DPD Cloud Webservice. Click on the Shipping centre API log tab and select the DPDCloudWebservice process.

5.1. CLOUD_USERDATA_NOACCESS

This entry is recorded in the log when access is denied.

Message Explanation

CLOUD_USERDATA_NOACCESS_SHIPMENTSERVICE

No access rights to the shipping service.

CLOUD_USERDATA_NOACCESS_COD

No access rights to the shipping service Cash on delivery.

CLOUD_USERDATA_NOACCESS_PREDICT

No access rights to the shipping service Predict.

5.2. CLOUD_ADDRESS

This entry is recorded in the log when address data is missing or incorrect. It is also possible that a parameter exceeded the maximum character length. The table lists several examples. However, the list is not exhaustive.

Message Explanation

CLOUD_ADDRESS_PHONE

The telephone number is missing or incorrect. Format: 5 to 20 characters.

CLOUD_ADDRESS_NEEDMAIL

The email address is missing. You are required to specify the recipient’s email address.

CLOUD_STATE_STATESHORT

The country in ISO3166-2 format: exactly 2 characters.

CLOUD_ADDRESS_COMPANYANDNAMEEMPTY

Company or name required.

CLOUD_API_ORDER_WEIGHT

Maximum weight exceeded. 31.5 kg can be shipped at maximum.

5.3. CLOUD_API_ORDER

This entry is recorded in the log when errors occur while registering shipping orders.

Event Explanation

CLOUD_API_ORDER_MAXORDERS

The maximum number of registered shipping orders was exceeded. It is not possible to register multiple shipments at the same time.

CLOUD_API_ORDER_SHIPSERVICE

Invalid shipping service.

CLOUD_API_ORDER_CODAMOUNT

Invalid cash on delivery amount. This must be between 1.00 and 5000.00 Euro.

CLOUD_API_ORDER_EXPRESS_DEU_COUNTRY

The selected express option is only available for Germany.

CLOUD_API_ORDER_CODPURPOSE

The cash on delivery reference contains too many characters. No more than 14 characters are allowed.

6. PayPal log entries

This chapter provides information about all of the log entries that relate to retrieving the PayPal settlement report.

6.1. CronPayPalSettlement

The CronPayPalSettlement log entries relate to connecting with the PayPal SFTP server.

Event Explanation

PayPal SFTP connection established

Indicates that the connection to the PayPal SFTP server was established.

PayPal SFTP xxx files downloaded

Indicates the number of CSV files that were downloaded.

PayPal SFTP no files found in /ppreports/outgoing directory

Indicates that no files were found to download.

PayPal SFTP disconnect

Indicates that the connection to the server was ended.

PayPal SFTP Exception: …​

Returns the server’s error message when an error occurs.

6.2. PayPalSettlement

The PayPalSettlement log entries relate to the transactions that are included in the settlement reports. The PayPal transaction ID is displayed in plentymarkets. It is listed as the designated use for a payment.

Event Explanation

The settlement report xxx contains xxx lines and xxx transactions.

Indicates the number of lines in the report and the transactions that are included in the report. This event neither specifies whether the transactions were already processed nor how they were processed.

xxx of xxx transactions were successfully assigned. xxx transactions were not assigned.

Indicates the total number of transactions in a settlement report. It also specifies how many of these transactions were assigned to an order and how many were not. There are two different reasons why a transaction is not assigned. On the one hand, the transaction may not match any of the orders that were found. On the other hand, the payment may have already been assigned to the order and therefore, the transaction in the file is no longer assigned.

The settlement report xxx could not be opened.

This message is displayed if the file no longer exists or if the file can no longer be read.

Transaction xxx was assigned.

This message is displayed for every assigned transaction. The transaction belongs to the settlement report that was named by the previous event The settlement report xxx contains xxx lines and xxx transactions.

Transaction xxx was not assigned.

This message is displayed for every transaction that was not assigned. The transaction belongs to the settlement report that was named by the previous event The settlement report xxx contains xxx lines and xxx transactions.

To top