capabilities.work

Announce a Shipment and Get its Return Portal URL

A 2-step recipe with Sendcloud. We can help you get access.

Recipe · 2 steps

Announce a Shipment and Get its Return Portal URL

with Sendcloud
Works with AI assistants

Announce a shipment and retrieve its return portal URL.

  1. Create and announce the shipment synchronously, returning the shipment id used to look up its return portal URL.
  2. Retrieve the return portal URL for the announced shipment so the customer can be sent a link to initiate a return.
What you'll need to have ready
  • toAddress: Recipient address object (name, address_line_1, postal_code, city, country_code).
  • fromAddress: Sender address object (name, address_line_1, postal_code, city, country_code).
  • shippingOptionCode: Shipping option code selecting carrier and method (e.g. postnl:standard).
  • contractId: Optional direct carrier contract id to use.
  • orderNumber: Your order number to associate with the shipment.
  • parcels: List of parcel objects with dimensions, weight, and optional parcel_items.
For your developer

Arazzo workflow sendcloud:announce-shipment-return-portal, 2 operations: sc-public-v3-scp-post-announce_shipment → sc-public-v3-scp-get-return_portal_url. Specs on APIs.io.

More recipes with Sendcloud

Announce a Shipment with LabelBulk Print Labels for Recent ParcelsCancel a Shipment with ConfirmationCreate a Parcel and Fetch its LabelCreate a Parcel and Get its Return Portal URLCreate a Parcel and Track its ShipmentCreate a Return and Cancel It If CancellableRegister an External Parcel and Track ItShip an Order Asynchronously and Poll the ParcelShip an Order Synchronously and Track It