Skip to main content
GET
/
brand
/
{brand_domain}
/
return-portal
/
outgoing
Retrieve an outgoing parcel
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/brand/{brand_domain}/return-portal/outgoing
{
  "data": {
    "parcel": {
      "id": 1,
      "address": "string",
      "address_2": "string",
      "address_divided": {
        "street": "string",
        "house_number": "string"
      },
      "house_number": "string",
      "city": "string",
      "company_name": "string",
      "country": {
        "iso_2": "NL",
        "iso_3": "NLD",
        "name": "string"
      },
      "to_state": "string",
      "email": "string",
      "name": "string",
      "postal_code": "string",
      "telephone": "string",
      "tracking_number": "string",
      "order_number": "string",
      "to_coordinates": {
        "latitude": -3.402823669209385e+38,
        "longitude": -3.402823669209385e+38
      },
      "collo_count": 1,
      "weight": "string",
      "carrier": {
        "code": "string"
      }
    },
    "products": [
      {
        "id": "string",
        "name": "string",
        "price": "string",
        "image_url": "https://example.com/image.png",
        "quantity": 0,
        "returnable": true
      }
    ],
    "carriers": [
      {
        "code": "string",
        "name": "string",
        "logo": {
          "full": "../dictionary",
          "icon": "../dictionary"
        }
      }
    ],
    "service_point": {
      "id": 10875349,
      "code": "217165",
      "is_active": true,
      "shop_type": null,
      "extra_data": {
        "partner_name": "PostNL",
        "sales_channel": "AFHAALPUNT",
        "terminal_type": "NRS",
        "retail_network_id": "PNPNL-01"
      },
      "name": "Media Markt Eindhoven Centrum B.V.",
      "street": "Boschdijktunnel",
      "house_number": "1",
      "postal_code": "5611AG",
      "city": "EINDHOVEN",
      "latitude": "51.441444",
      "longitude": "5.475185",
      "email": "",
      "phone": "",
      "homepage": "",
      "carrier": "postnl",
      "country": "NL",
      "formatted_opening_times": {
        "0": [
          "10:00 - 20:00"
        ],
        "1": [
          "10:00 - 20:00"
        ],
        "2": [
          "10:00 - 20:00"
        ],
        "3": [
          "10:00 - 20:00"
        ],
        "4": [
          "10:00 - 20:00"
        ],
        "5": [
          "10:00 - 18:00"
        ],
        "6": []
      },
      "open_tomorrow": true,
      "open_upcoming_week": true,
      "distance": 381
    },
    "shop_distances": [
      {
        "id": 1,
        "distance": 1
      }
    ],
    "national_carrier_contact": "https://example.com",
    "national_carrier": {
      "name": "string",
      "drop_off_finder": "string",
      "logo": {
        "full": "https://sendcloud-prod-scp-static-files.s3.amazonaws.com/ups/img/logo.svg",
        "icon": "https://sendcloud-prod-scp-static-files.s3.amazonaws.com/ups/img/icon.svg"
      },
      "code": "ups"
    },
    "carrier_drop_off_finder": {},
    "labelless_service_point": {
      "id": 10875349,
      "code": "217165",
      "is_active": true,
      "shop_type": null,
      "extra_data": {
        "partner_name": "PostNL",
        "sales_channel": "AFHAALPUNT",
        "terminal_type": "NRS",
        "retail_network_id": "PNPNL-01"
      },
      "name": "Media Markt Eindhoven Centrum B.V.",
      "street": "Boschdijktunnel",
      "house_number": "1",
      "postal_code": "5611AG",
      "city": "EINDHOVEN",
      "latitude": "51.441444",
      "longitude": "5.475185",
      "email": "",
      "phone": "",
      "homepage": "",
      "carrier": "postnl",
      "country": "NL",
      "formatted_opening_times": {
        "0": [
          "10:00 - 20:00"
        ],
        "1": [
          "10:00 - 20:00"
        ],
        "2": [
          "10:00 - 20:00"
        ],
        "3": [
          "10:00 - 20:00"
        ],
        "4": [
          "10:00 - 20:00"
        ],
        "5": [
          "10:00 - 18:00"
        ],
        "6": []
      },
      "open_tomorrow": true,
      "open_upcoming_week": true,
      "distance": 381
    },
    "shipping_products": [
      {
        "name": "PostNL Standard return",
        "carrier": "postnl",
        "service_points_carrier": "postnl",
        "functionalities": {
          "age_check": 0,
          "b2b": true,
          "b2c": true,
          "boxable": true,
          "bulky_goods": true,
          "carrier_billing_type": "country",
          "cash_on_delivery": true,
          "dangerous_goods": true,
          "delivery_attempts": 0,
          "delivery_before": "string",
          "delivery_deadline": "best_effort",
          "direct_contract_only": true,
          "eco_delivery": true,
          "ers": true,
          "first_mile": "dropoff",
          "flex_delivery": true,
          "form_factor": "parcel",
          "fragile_goods": true,
          "fresh_goods": true,
          "harmonized_label": true,
          "id_check": true,
          "incoterm": "ddp",
          "insurance": 0,
          "labelless": true,
          "last_mile": "home_delivery",
          "manually": true,
          "multicollo": true,
          "neighbor_delivery": true,
          "non_conveyable": true,
          "personalized_delivery": true,
          "premium": true,
          "priority": "standard",
          "registered_delivery": true,
          "returns": true,
          "segment": "a+",
          "service_area": "domestic",
          "signature": true,
          "size": "s",
          "sorted": true,
          "surcharge": true,
          "tracked": true,
          "tyres": true,
          "weekend_delivery": "saturday"
        },
        "methods": [
          {
            "id": 1,
            "name": "PostNL Return",
            "functionalities": {
              "age_check": 0,
              "b2b": true,
              "b2c": true,
              "boxable": true,
              "bulky_goods": true,
              "carrier_billing_type": "country",
              "cash_on_delivery": true,
              "dangerous_goods": true,
              "delivery_attempts": 0,
              "delivery_before": "string",
              "delivery_deadline": "best_effort",
              "direct_contract_only": true,
              "eco_delivery": true,
              "ers": true,
              "first_mile": "dropoff",
              "flex_delivery": true,
              "form_factor": "parcel",
              "fragile_goods": true,
              "fresh_goods": true,
              "harmonized_label": true,
              "id_check": true,
              "incoterm": "ddp",
              "insurance": 0,
              "labelless": true,
              "last_mile": "home_delivery",
              "manually": true,
              "multicollo": true,
              "neighbor_delivery": true,
              "non_conveyable": true,
              "personalized_delivery": true,
              "premium": true,
              "priority": "standard",
              "registered_delivery": true,
              "returns": true,
              "segment": "a+",
              "service_area": "domestic",
              "signature": true,
              "size": "s",
              "sorted": true,
              "surcharge": true,
              "tracked": true,
              "tyres": true,
              "weekend_delivery": "saturday"
            },
            "shipping_product_code": "string",
            "properties": {
              "min_weight": 0,
              "max_weight": 0,
              "max_dimensions": {
                "length": 0,
                "width": 0,
                "height": 0,
                "unit": "string"
              }
            },
            "pickup_date": null
          }
        ],
        "code": "string"
      }
    ],
    "applicable_actions": [
      {
        "id": "ship_with",
        "name": "Ship with",
        "field": "ship_with",
        "priority": 1,
        "value": "dhl:complete/dropoff,return,labelless",
        "condition": {
          "all": [
            {
              "id": "from_country",
              "operator": "eq",
              "value": "NL"
            }
          ]
        }
      }
    ]
  },
  "service_points_token": "string",
  "access_token": "string"
}
On a successful lookup, along with the parcel data, you will receive two JWT tokens: one for the incoming parcel creation, and one for service points lookup.

Path Parameters

​
brand_domain
string
required

The domain you defined in the brand settings.

Minimum string length: 1

Query Parameters

​
postal_code
string
required

The postal code of the outgoing parcel.

Minimum string length: 1
​
identifier
string
required

Either the tracking number or the order number of the outgoing parcel.

Minimum string length: 1
​
omit_service_points
boolean
default:false

If true, exclude response fields with basic service point information:

  • service_point
  • labelless_service_point
  • shop_distances

Response

OK

​
data
object
required
​
service_points_token
string
required

Access token that can be used to fetch service points at https://servicepoints.sendcloud.sc/api/v2/service-points

Minimum string length: 1
​
access_token
string
required

Access token that can be used when interacting with the Return portal API

Minimum string length: 1