Skip to content

Overview

Read your DPD account's storefronts, products, purchases, customers and subscribers.

The DPD API is a read-only window into your DPD account. With the API you are able to view all of the data that is available in your account.

Authenticate with HTTP Basic authentication: your DPD username, and the API password from your profile in the DPD admin.

Pagination

Collections return at most 100 records per page when you pass page. Without page, the API tries to return every record, which isn’t guaranteed to work on large accounts. Start with page=1 and count up until you get a 404 with {"status": "NOTFOUND"}.

An empty result is also a 404 with {"status": "NOTFOUND"}, not an empty list.

Dates and times

Responses give dates as UNIX timestamps (seconds). Date filters accept anything PHP’s strtotime() accepts, in your account’s time zone unless the value includes one, such as ISO 8601 (2004-02-12T15:19:21+00:00) or RFC 2822 (Thu, 21 Dec 2000 16:01:07 +0200).

Money

Amounts are strings with two decimal places, such as "19.99".

Information

  • OpenAPI version: 3.1.0

Your DPD username, and the API password from your profile in the DPD admin.

Security scheme type: http