Brands

• The Return portal
• The tracking page, a Sendcloud-hosted delivery status page that replaces the carrier’s tracking page
• Tracking notifications sent by email, SMS, and WhatsApp
• Shipping labels, which show your print logo (not all carriers support logos on their labels)

​

Create a brand

​

Retrieve your brands

curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/brands \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic <credentials>'

{
  "data": [
    {
      "id": 1,
      "name": "Sendcloud B.V",
      "domain": "sendcloud-shop",
      "color": "#112857",
      "website": "https://www.sendcloud.com",
      "screen_logo": "https://media.sendcloud.sc/brands/1/Sendcloud.png",
      "notify_reply_to_email": "info@sendcloud.com",
      "hide_powered_by": false,
      ...
    }
  ]
}

​

Apply a brand to a shipment

• The Shipments API, when you create a shipment
• The Ship an Order API, when you ship an order
• The Returns API, when you create a return

{
  "brand_id": 1,
  "from_address": {
    "sender_address_id": 192
  },
  "to_address": {
    ...
  },
  "ship_with": {
    ...
  },
  "parcels": [
    ...
  ]
}

​

How the brand is determined

1. The brand_id from your request.
2. The brand of the sender address in from_address.sender_address_id. When you create a shipment with shipping rules, a rule can set this sender address.
3. No brand. This happens when you provide the full from_address instead of a sender_address_id.

1. The brand of the sender address set by a shipping rule. This brand is used even if you specify a brand_id, and the brand_id isn’t validated.
2. The brand_id from your request.
3. The brand of the order’s sender address. This is the first sender address found in this list:
   1. A sender address that was changed on the order itself
   2. The sender address selected at checkout, for orders placed through a checkout
   3. The sender_address_id from your request
   4. Your default sender address

1. The brand_id from your request.
2. No brand.

1. Log in to your Sendcloud account and go to Settings > Addresses.
2. Create a new sender address, or edit an existing one.
3. Under Brands, select the brand you want to link to this address and Save.

​

Where else brands are used

• Retrieve a return portal URL returns a link to the Return portal of the shipment’s brand. The endpoint returns a 404 error if no brand is applied to the shipment, if the brand has no Shipping Portal URL, or if the brand’s Return portal isn’t active.
• Parcel tracking lets you set a brand_id in the details of parcels you register for tracking.
• Parcel reports can be filtered by brand_id, and can include brand_id and brand_name columns.