API docs Endpoints
Check your API key
See which ParcelParcel account your API key belongs to.
https://services.parcelparcel.com/partners-api/v1/meExample request
Check which account your key belongs to
curl --request GET 'https://services.parcelparcel.com/partners-api/v1/me' \
--header 'X-PP-API: {YourAPIKey}@{YourAPISecret}' \
--header 'Content-Type: application/json'const response = await fetch("https://services.parcelparcel.com/partners-api/v1/me", {
method: "GET",
headers: {
"X-PP-API": "{YourAPIKey}@{YourAPISecret}",
"Content-Type": "application/json",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.get(
"https://services.parcelparcel.com/partners-api/v1/me",
headers={
"X-PP-API": "{YourAPIKey}@{YourAPISecret}",
"Content-Type": "application/json",
},
)
print(response.json())Tip: copy the cURL and paste it in Postman under Import, or straight into the URL bar of a new request. Postman fills in the method, headers and body for you. Replace {YourAPIKey}@{YourAPISecret} with your own API key and secret (use your sandbox key while testing), or import the whole Postman Collection.
This endpoint returns the account that your API key belongs to. It has no body and changes nothing, so it's the quickest way to check that your credentials work before you build anything else.
It's also handy when your integration connects several ParcelParcel accounts: call it to show your user which account is connected.
Header
You need to add the following headers:
| Name | Value |
|---|---|
Content-Type | application/json |
X-PP-API | {YourAPIKey}@{YourAPISecret} |
Don't you have an API Key and API Secret yet? Check our Authentication page.
Body
There is no body and there are no parameters.
Response
| Name | Value | Comments |
|---|---|---|
errors | (bool) | false when your credentials work. |
message | (string) | Query processed successfully |
data.username | (string) | The email address of the ParcelParcel account the key belongs to. |
Your live key and your sandbox key belong to the same account, so both return the same username.
Example response
{
"errors": false,
"message": "Query processed successfully",
"data": {
"username": "[email protected]"
}
}When the key is wrong
If the X-PP-API header is missing, or the key or secret is wrong, you don't get JSON back but the text:
Check that the header has the form {YourAPIKey}@{YourAPISecret}, with an @ between them and no spaces. Did you just rotate your credentials? Then the old pair no longer works.
Examples
Don't know how to test these requests? Check our guide.
Request example - Check which account your key belongs to
curl --location --request GET 'https://services.parcelparcel.com/partners-api/v1/me' \
--header 'X-PP-API: {YourAPIKey}@{YourAPISecret}' \
--header 'Content-Type: application/json'GET /partners-api/v1/me HTTP/1.1
Host: services.parcelparcel.com
X-PP-API: {YourAPIKey}@{YourAPISecret}
Content-Type: application/json