Articles in this section

Deliverr API Guide - Parcel Integration

Note: This guide is meant to be accompanied with Deliverr's API spec:

https://api.deliverr.com/documentation/v1/spec#tag/Parcel-Integration

 

To access any of the parcels endpoints, you will need to have authenticated with the api/parcel-integration as a scope in the Authorization process. Note: during the Authentication process you will be redirected to a consent screen that looks like this: 

login.png

Here, you should sign in using the email address that you used to sign up for the SellerPortal (where you got your sellerID). If you need any assistance with this, your Account Executive should be able to help you find this information.

A guide to the Authorization process can be found here:

https://support.deliverr.com/hc/en-us/articles/6857029846807-Deliverr-API-Guide-Authentication

 

The Parcel Integration API allows you to do the following:

  • Create a Label Generation Batch

This will purchase labels for you and also email the reports and labels to you. 

For specific API reference for each of the endpoints, please visit this link.

  1. Create Label Generation Job POST parcel-integration/v1/job

    • To create a new label batch, make the following request to the Parcel Integration API’s CreateLabelGenerationJob endpoint:
    curl --location --request POST '<https://api.deliverr.com/parcel-integration/v1/job>' \\
--header 'Authorization: Bearer {valid_access_token}' \\
--header 'Content-Type: application/json' \\
--data-raw '{ 
    "integrationChannelId": "shipstation",
        "estimatedOrderCount": "ESTIMATED ORDER COUNT"
}'
    • This will give you a response contiaining the job ID and a message that the job was created. 
    • After this the reports will be emailed to you after the labels are purchased. (Note: this can take a few hours).

Related articles