Skip to main content

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

A sender address is required information when creating a shipping label. It specifies a ship from address to indicate where a parcel came from, and where it should be returned to in the event that something goes wrong. Sender addresses are configured in the Sendcloud platform, and can then be used to specify a ship from location, or a ship to location for returns, when you interact with our APIs.
Sender addresses correlate with the type of methods that you can retrieve when you make an API call to Get shipping rates or Choose a shipping method.

​
Default sender addresses

Sendcloud allows you to store multiple sender addresses in your account details, but one address must always be marked as default.
  • Whenever you create a parcel without specifying a sender address id, your default address will be automatically used to create your label
  • In turn, the brand associated with your default sender address is the one that will be assigned to any parcels you create.

​
Ship from a different sender address location

If you have multiple sender addresses, you can specify a different sender address id to ship a parcel from a different location. You can retrieve the id for each of your sender addresses by making a GET request to the Retrieve a list of sender addresses endpoint.

​
Retrieve your configured sender addresses

Make a GET request to the Retrieve a list of sender addresses endpoint to retrieve all sender addresses configured for your account:
Example request using curl
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/user/addresses/sender \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic <credentials>'
A successful response will return a JSON object containing an array of all sender addresses configured for your account, similar to the following example:
Response body
{
  "sender_addresses": [
    {
      "id": 2,
      "company_name": "French Company",
      "contact_name": "Marie Doe",
      "email": "info@sendcloud.fr",
      "telephone": "",
      "street": "Rue Villiers de l'Isle Adam",
      "house_number": "33",
      "postal_box": "",
      "postal_code": "35000",
      "city": "Rennes",
      "country": "FR",
      "vat_number": "NL123456789B01",
      "coc_number": "NL12345678",
      "eori_number": "NL123456789",
      "brand_id": 1,
    },
    {
      "id": 1,
      "company_name": "Sendcloud",
      "contact_name": "John Doe",
      "email": "johndoe@sendcloud.com",
      "telephone": "+31626262626",
      "street": "Bogert",
      "house_number": "115",
      "postal_box": "",
      "postal_code": "5642 CV",
      "city": "Eindhoven",
      "country": "NL",
      "vat_number": "NL123456789B01",
      "coc_number": "NL12345678",
      "eori_number": "NL123456789",
      "brand_id": 2,
    }
  ]
In this example, two different addresses are stored to this account information, each with its own linked brand.
  • To ship a parcel from our French store location, we can specify the id for this sender address in the sender_address field when you make a POST request to the Create a parcel endpoint.
  • To see shipping methods applicable for parcels shipping from France, you should specify the sender_address id of your secondary location when you make a GET request to the Retrieve a list of shipping methods endpoint.

​
Automate your ‘ship from’ location with shipping rules

You can make use of Shipping rules to automatically create parcels from a specific sender address, based on pre-defined conditions. You can configure shipping rules to automatically ship parcels from a specific sender address based on criteria such as from_country, to_country and integration, plus many more. When properly configured, shipping rules interact with parcels created through the API to remove much of the manual decision making involved in choosing a sender address address per parcel.

Shipping rules

Read more about creating and applying shipping rules