Create Or Update Integration Shipment with Sendcloud API

Pipedream makes it easy to connect APIs for Sendcloud and 2,800+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Or Update Integration Shipment with the Sendcloud API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Or Update Integration Shipment with the Sendcloud API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Or Update Integration Shipment action
1. Connect your Sendcloud account
2. Select a Integration ID
3. Configure Address
4. Configure Address 2
5. Configure Company Name
6. Configure Created At
7. Select a Currency
8. Configure Customs Invoice Number
9. Select a Customs Shipment Type
10. Configure Email
11. Configure External Order ID
12. Configure External Shipment ID
13. Configure House Number
14. Configure Name
15. Configure Order Number
16. Configure Order Status ID
17. Configure Order Status Message
18. Configure Parcel Items
19. Configure Payment Status ID
20. Configure Payment Status Message
21. Configure Postal Code
22. Configure Shipping Method Checkout Name
23. Configure Telephone
24. Configure To Post Number
25. Select a country
26. Select a Service Point
27. Configure To State
28. Configure Updated At
29. Optional- Configure City
30. Select a Shipping Method ID
31. Optional- Configure Total Order Value
32. Optional- Configure Weight
33. Optional- Configure Checkout Payload
34. Optional- Configure Width
35. Optional- Configure Height
36. Optional- Configure Length
37. Optional- Configure Costs & Tax Details
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Or Update Integration Shipment with Sendcloud API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Sendcloud

Try it

Create Or Update Integration Shipment with Sendcloud API on New Submission from Typeform API

Typeform + Sendcloud

Try it

Create Or Update Integration Shipment with Sendcloud API on New Submission (Instant) from Jotform API

Jotform + Sendcloud

Try it

Create Or Update Integration Shipment with Sendcloud API on New Scheduled Tasks from Pipedream API

Pipedream + Sendcloud

Try it

Create Or Update Integration Shipment with Sendcloud API on New Download Counts from npm API

npm + Sendcloud

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Or Update Integration Shipment on Sendcloud

Description:Create or update an integration shipment. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/branches/v2/integrations/operations/create-a-integration-shipment)

Version:0.0.1

Key:sendcloud-create-update-integration-shipment

View on GitHub

Code#

import app from "../../sendcloud.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "sendcloud-create-update-integration-shipment",
  name: "Create Or Update Integration Shipment",
  description: "Create or update an integration shipment. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/branches/v2/integrations/operations/create-a-integration-shipment)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    integrationId: {
      propDefinition: [
        app,
        "integrationId",
      ],
    },
    address: {
      description: "The address of the shipment.",
      propDefinition: [
        app,
        "address",
      ],
    },
    address2: {
      propDefinition: [
        app,
        "address",
      ],
      label: "Address 2",
      description: "A secondary address of the shipment.",
    },
    companyName: {
      propDefinition: [
        app,
        "companyName",
      ],
    },
    createdAt: {
      propDefinition: [
        app,
        "createdAt",
      ],
    },
    currency: {
      propDefinition: [
        app,
        "currency",
      ],
    },
    customsInvoiceNr: {
      propDefinition: [
        app,
        "customsInvoiceNr",
      ],
    },
    customsShipmentType: {
      propDefinition: [
        app,
        "customsShipmentType",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    externalOrderId: {
      propDefinition: [
        app,
        "externalOrderId",
      ],
    },
    externalShipmentId: {
      propDefinition: [
        app,
        "externalShipmentId",
      ],
    },
    houseNumber: {
      propDefinition: [
        app,
        "houseNumber",
      ],
    },
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
    orderNumber: {
      propDefinition: [
        app,
        "orderNumber",
      ],
    },
    orderStatusId: {
      propDefinition: [
        app,
        "orderStatusId",
      ],
    },
    orderStatusMessage: {
      propDefinition: [
        app,
        "orderStatusMessage",
      ],
    },
    parcelItems: {
      propDefinition: [
        app,
        "parcelItems",
      ],
    },
    paymentStatusId: {
      propDefinition: [
        app,
        "paymentStatusId",
      ],
    },
    paymentStatusMessage: {
      propDefinition: [
        app,
        "paymentStatusMessage",
      ],
    },
    postalCode: {
      propDefinition: [
        app,
        "postalCode",
      ],
    },

    shippingMethodCheckoutName: {
      propDefinition: [
        app,
        "shippingMethodCheckoutName",
      ],
    },
    telephone: {
      propDefinition: [
        app,
        "telephone",
      ],
    },
    toPostNumber: {
      propDefinition: [
        app,
        "toPostNumber",
      ],
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
    },
    toServicePoint: {
      propDefinition: [
        app,
        "servicePointId",
        ({ country }) => ({
          country,
        }),
      ],
    },
    toState: {
      propDefinition: [
        app,
        "toState",
      ],
    },
    updatedAt: {
      propDefinition: [
        app,
        "updatedAt",
      ],
    },
    city: {
      propDefinition: [
        app,
        "city",
      ],
      description: "The city of the shipment.",
    },
    shippingMethod: {
      propDefinition: [
        app,
        "shippingMethodId",
      ],
    },
    totalOrderValue: {
      propDefinition: [
        app,
        "totalOrderValue",
      ],
    },
    weight: {
      propDefinition: [
        app,
        "weight",
      ],
    },
    checkoutPayload: {
      propDefinition: [
        app,
        "checkoutPayload",
      ],
    },
    width: {
      type: "string",
      label: "Width",
      description: "Volumetric width (decimal string)",
      optional: true,
    },
    height: {
      type: "string",
      label: "Height",
      description: "Volumetric height (decimal string)",
      optional: true,
    },
    length: {
      type: "string",
      label: "Length",
      description: "Volumetric length (decimal string)",
      optional: true,
    },
    customDetails: {
      propDefinition: [
        app,
        "customDetails",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      integrationId,
      address,
      address2,
      city,
      companyName,
      country,
      createdAt,
      currency,
      customsInvoiceNr,
      customsShipmentType,
      email,
      externalOrderId,
      externalShipmentId,
      houseNumber,
      name,
      orderNumber,
      orderStatusId,
      orderStatusMessage,
      parcelItems,
      paymentStatusId,
      paymentStatusMessage,
      postalCode,
      shippingMethod,
      shippingMethodCheckoutName,
      telephone,
      toPostNumber,
      toServicePoint,
      toState,
      totalOrderValue,
      updatedAt,
      weight,
      checkoutPayload,
      width,
      height,
      length,
      customDetails,
    } = this;

    const response = await app.upsertIntegrationShipment({
      $,
      integrationId,
      data: {
        shipments: [
          {
            address,
            address2,
            city,
            company_name: companyName,
            country,
            created_at: createdAt,
            currency,
            customs_invoice_nr: customsInvoiceNr,
            customs_shipment_type: customsShipmentType,
            email,
            external_order_id: externalOrderId,
            external_shipment_id: externalShipmentId,
            house_number: houseNumber,
            name,
            order_number: orderNumber,
            order_status: {
              id: orderStatusId,
              message: orderStatusMessage,
            },
            parcel_items: utils.parseArray(parcelItems),
            payment_status: {
              id: paymentStatusId,
              message: paymentStatusMessage,
            },
            postal_code: postalCode,
            shipping_method: shippingMethod,
            shipping_method_checkout_name: shippingMethodCheckoutName,
            telephone,
            to_post_number: toPostNumber,
            to_service_point: toServicePoint,
            to_state: toState,
            total_order_value: totalOrderValue,
            updated_at: updatedAt,
            weight,
            checkout_payload: utils.parseJson(checkoutPayload),
            width,
            height,
            length,
            custom_details: utils.parseJson(customDetails),
          },
        ],
      },
    });

    $.export("$summary", "Successfully created or updated integration shipment");

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Sendcloud	`app`	`app`	This component uses the Sendcloud app.
Integration ID	`integrationId`	`string`	Select a value from the drop down menu.
Address	`address`	`string`	The address of the shipment.
Address 2	`address2`	`string`	A secondary address of the shipment.
Company Name	`companyName`	`string`	The company name of the shipment.
Created At	`createdAt`	`string`	Timestamp when the shipment was created in the shop system. Example: `2022-05-07T15:08:12.152000Z`
Currency	`currency`	`string`	Select a value from the drop down menu:`EURUSDGBP`
Customs Invoice Number	`customsInvoiceNr`	`string`	Commercial invoice number
Customs Shipment Type	`customsShipmentType`	`string`	Select a value from the drop down menu:`{ "value": "0", "label": "Gift" }{ "value": "1", "label": "Documents" }{ "value": "2", "label": "Commercial Goods" }{ "value": "3", "label": "Commercial Sample" }{ "value": "4", "label": "Returned Goods" }`
Email	`email`	`string`	The email of the recipient.
External Order ID	`externalOrderId`	`string`	External order ID assigned by the shop system
External Shipment ID	`externalShipmentId`	`string`	External shipment ID assigned by the shop system
House Number	`houseNumber`	`string`	House number of the recipient
Name	`name`	`string`	Name of the recipient
Order Number	`orderNumber`	`string`	Unique order number generated manually or by the shop system
Order Status ID	`orderStatusId`	`string`	Custom internal shop status ID
Order Status Message	`orderStatusMessage`	`string`	User-defined human readable status
Parcel Items	`parcelItems`	`string[]`	Array of JSON objects describing each item in the parcel. Each item must include the following fields: `description` (string, required): Description of the product. Example: `Bag` `hs_code` (string): Harmonized System Code (<= 12 chars). Example: `01013000` `origin_country` (string \| null): ISO 3166-1 alpha-2 country code where the product was produced. Example: `NL` `product_id` (string): Internal product ID. Example: `1458734634` `properties` (object): Key-value pairs with additional product properties (e.g., `{ "color": "Black" }`) `quantity` (integer, required): Number of units (>= 1). Example: `2` `sku` (string): Internal stock keeping unit. Example: `WW-DR-GR-XS-001` `value` (string, required): Price per item as a decimal string. Example: `19.99` `weight` (string \| null): Weight per item as a decimal string. Example: `0.5` `mid_code` (string \| null): Manufacturer's Identification code. Example: `NLOZR92MEL` `material_content` (string \| null): Description of materials. Example: `100% Cotton` `intended_use` (string \| null): Intended use of the contents. Example: `Personal use` Example item JSON: `{ "description": "Bag", "hs_code": "01013000", "origin_country": "NL", "product_id": "1458734634", "properties": { "color": "Black" }, "quantity": 2, "sku": "WW-DR-GR-XS-001", "value": "19.99", "weight": "0.5", "mid_code": "NLOZR92MEL", "material_content": "100% Cotton", "intended_use": "Personal use" }` Provide each array element as a JSON object string in the UI, or programmatically as an array of objects.
Payment Status ID	`paymentStatusId`	`string`	Custom internal payment status ID
Payment Status Message	`paymentStatusMessage`	`string`	User-defined payment status
Postal Code	`postalCode`	`string`	Zip code of the recipient
Shipping Method Checkout Name	`shippingMethodCheckoutName`	`string`	Human readable shipping method name
Telephone	`telephone`	`string`	The telephone number of the recipient.
To Post Number	`toPostNumber`	`string`	The post number of the recipient.
country	`country`	`string`	Select a value from the drop down menu:`{ "label": "Aruba", "value": "AW" }{ "label": "Afghanistan", "value": "AF" }{ "label": "Angola", "value": "AO" }{ "label": "Anguilla", "value": "AI" }{ "label": "Åland Islands", "value": "AX" }{ "label": "Albania", "value": "AL" }{ "label": "Andorra", "value": "AD" }{ "label": "United Arab Emirates", "value": "AE" }{ "label": "Argentina", "value": "AR" }{ "label": "Armenia", "value": "AM" }{ "label": "American Samoa", "value": "AS" }{ "label": "Antarctica", "value": "AQ" }{ "label": "French Southern Territories", "value": "TF" }{ "label": "Antigua and Barbuda", "value": "AG" }{ "label": "Australia", "value": "AU" }{ "label": "Austria", "value": "AT" }{ "label": "Azerbaijan", "value": "AZ" }{ "label": "Burundi", "value": "BI" }{ "label": "Belgium", "value": "BE" }{ "label": "Benin", "value": "BJ" }{ "label": "Bonaire, Sint Eustatius and Saba", "value": "BQ" }{ "label": "Burkina Faso", "value": "BF" }{ "label": "Bangladesh", "value": "BD" }{ "label": "Bulgaria", "value": "BG" }{ "label": "Bahrain", "value": "BH" }{ "label": "Bahamas", "value": "BS" }{ "label": "Bosnia and Herzegovina", "value": "BA" }{ "label": "Saint Barthélemy", "value": "BL" }{ "label": "Belarus", "value": "BY" }{ "label": "Belize", "value": "BZ" }{ "label": "Bermuda", "value": "BM" }{ "label": "Bolivia, Plurinational State of", "value": "BO" }{ "label": "Brazil", "value": "BR" }{ "label": "Barbados", "value": "BB" }{ "label": "Brunei Darussalam", "value": "BN" }{ "label": "Bhutan", "value": "BT" }{ "label": "Bouvet Island", "value": "BV" }{ "label": "Botswana", "value": "BW" }{ "label": "Central African Republic", "value": "CF" }{ "label": "Canada", "value": "CA" }{ "label": "Cocos (Keeling) Islands", "value": "CC" }{ "label": "Switzerland", "value": "CH" }{ "label": "Chile", "value": "CL" }{ "label": "China", "value": "CN" }{ "label": "Côte d'Ivoire", "value": "CI" }{ "label": "Cameroon", "value": "CM" }{ "label": "Congo, Democratic Republic of the", "value": "CD" }{ "label": "Congo", "value": "CG" }{ "label": "Cook Islands", "value": "CK" }{ "label": "Colombia", "value": "CO" }{ "label": "Comoros", "value": "KM" }{ "label": "Cabo Verde", "value": "CV" }{ "label": "Costa Rica", "value": "CR" }{ "label": "Cuba", "value": "CU" }{ "label": "Curaçao", "value": "CW" }{ "label": "Christmas Island", "value": "CX" }{ "label": "Cayman Islands", "value": "KY" }{ "label": "Cyprus", "value": "CY" }{ "label": "Czechia", "value": "CZ" }{ "label": "Germany", "value": "DE" }{ "label": "Djibouti", "value": "DJ" }{ "label": "Dominica", "value": "DM" }{ "label": "Denmark", "value": "DK" }{ "label": "Dominican Republic", "value": "DO" }{ "label": "Algeria", "value": "DZ" }{ "label": "Ecuador", "value": "EC" }{ "label": "Egypt", "value": "EG" }{ "label": "Eritrea", "value": "ER" }{ "label": "Western Sahara", "value": "EH" }{ "label": "Spain", "value": "ES" }{ "label": "Estonia", "value": "EE" }{ "label": "Ethiopia", "value": "ET" }{ "label": "Finland", "value": "FI" }{ "label": "Fiji", "value": "FJ" }{ "label": "Falkland Islands (Malvinas)", "value": "FK" }{ "label": "France", "value": "FR" }{ "label": "Faroe Islands", "value": "FO" }{ "label": "Micronesia, Federated States of", "value": "FM" }{ "label": "Gabon", "value": "GA" }{ "label": "United Kingdom of Great Britain and Northern Ireland", "value": "GB" }{ "label": "Georgia", "value": "GE" }{ "label": "Guernsey", "value": "GG" }{ "label": "Ghana", "value": "GH" }{ "label": "Gibraltar", "value": "GI" }{ "label": "Guinea", "value": "GN" }{ "label": "Guadeloupe", "value": "GP" }{ "label": "Gambia", "value": "GM" }{ "label": "Guinea-Bissau", "value": "GW" }{ "label": "Equatorial Guinea", "value": "GQ" }{ "label": "Greece", "value": "GR" }{ "label": "Grenada", "value": "GD" }{ "label": "Greenland", "value": "GL" }{ "label": "Guatemala", "value": "GT" }{ "label": "French Guiana", "value": "GF" }{ "label": "Guam", "value": "GU" }{ "label": "Guyana", "value": "GY" }{ "label": "Hong Kong", "value": "HK" }{ "label": "Heard Island and McDonald Islands", "value": "HM" }{ "label": "Honduras", "value": "HN" }{ "label": "Croatia", "value": "HR" }{ "label": "Haiti", "value": "HT" }{ "label": "Hungary", "value": "HU" }{ "label": "Indonesia", "value": "ID" }{ "label": "Isle of Man", "value": "IM" }{ "label": "India", "value": "IN" }{ "label": "British Indian Ocean Territory", "value": "IO" }{ "label": "Ireland", "value": "IE" }{ "label": "Iran, Islamic Republic of", "value": "IR" }{ "label": "Iraq", "value": "IQ" }{ "label": "Iceland", "value": "IS" }{ "label": "Israel", "value": "IL" }{ "label": "Italy", "value": "IT" }{ "label": "Jamaica", "value": "JM" }{ "label": "Jersey", "value": "JE" }{ "label": "Jordan", "value": "JO" }{ "label": "Japan", "value": "JP" }{ "label": "Kazakhstan", "value": "KZ" }{ "label": "Kenya", "value": "KE" }{ "label": "Kyrgyzstan", "value": "KG" }{ "label": "Cambodia", "value": "KH" }{ "label": "Kiribati", "value": "KI" }{ "label": "Saint Kitts and Nevis", "value": "KN" }{ "label": "Korea, Republic of", "value": "KR" }{ "label": "Kuwait", "value": "KW" }{ "label": "Lao People's Democratic Republic", "value": "LA" }{ "label": "Lebanon", "value": "LB" }{ "label": "Liberia", "value": "LR" }{ "label": "Libya", "value": "LY" }{ "label": "Saint Lucia", "value": "LC" }{ "label": "Liechtenstein", "value": "LI" }{ "label": "Sri Lanka", "value": "LK" }{ "label": "Lesotho", "value": "LS" }{ "label": "Lithuania", "value": "LT" }{ "label": "Luxembourg", "value": "LU" }{ "label": "Latvia", "value": "LV" }{ "label": "Macao", "value": "MO" }{ "label": "Saint Martin (French part)", "value": "MF" }{ "label": "Morocco", "value": "MA" }{ "label": "Monaco", "value": "MC" }{ "label": "Moldova, Republic of", "value": "MD" }{ "label": "Madagascar", "value": "MG" }{ "label": "Maldives", "value": "MV" }{ "label": "Mexico", "value": "MX" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "North Macedonia", "value": "MK" }{ "label": "Mali", "value": "ML" }{ "label": "Malta", "value": "MT" }{ "label": "Myanmar", "value": "MM" }{ "label": "Montenegro", "value": "ME" }{ "label": "Mongolia", "value": "MN" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Mozambique", "value": "MZ" }{ "label": "Mauritania", "value": "MR" }{ "label": "Montserrat", "value": "MS" }{ "label": "Martinique", "value": "MQ" }{ "label": "Mauritius", "value": "MU" }{ "label": "Malawi", "value": "MW" }{ "label": "Malaysia", "value": "MY" }{ "label": "Mayotte", "value": "YT" }{ "label": "Namibia", "value": "NA" }{ "label": "New Caledonia", "value": "NC" }{ "label": "Niger", "value": "NE" }{ "label": "Norfolk Island", "value": "NF" }{ "label": "Nigeria", "value": "NG" }{ "label": "Nicaragua", "value": "NI" }{ "label": "Niue", "value": "NU" }{ "label": "Netherlands, Kingdom of the", "value": "NL" }{ "label": "Norway", "value": "NO" }{ "label": "Nepal", "value": "NP" }{ "label": "Nauru", "value": "NR" }{ "label": "New Zealand", "value": "NZ" }{ "label": "Oman", "value": "OM" }{ "label": "Pakistan", "value": "PK" }{ "label": "Panama", "value": "PA" }{ "label": "Pitcairn", "value": "PN" }{ "label": "Peru", "value": "PE" }{ "label": "Philippines", "value": "PH" }{ "label": "Palau", "value": "PW" }{ "label": "Papua New Guinea", "value": "PG" }{ "label": "Poland", "value": "PL" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Korea, Democratic People's Republic of", "value": "KP" }{ "label": "Portugal", "value": "PT" }{ "label": "Paraguay", "value": "PY" }{ "label": "Palestine, State of", "value": "PS" }{ "label": "French Polynesia", "value": "PF" }{ "label": "Qatar", "value": "QA" }{ "label": "Réunion", "value": "RE" }{ "label": "Romania", "value": "RO" }{ "label": "Russian Federation", "value": "RU" }{ "label": "Rwanda", "value": "RW" }{ "label": "Saudi Arabia", "value": "SA" }{ "label": "Sudan", "value": "SD" }{ "label": "Senegal", "value": "SN" }{ "label": "Singapore", "value": "SG" }{ "label": "South Georgia and the South Sandwich Islands", "value": "GS" }{ "label": "Saint Helena, Ascension and Tristan da Cunha", "value": "SH" }{ "label": "Svalbard and Jan Mayen", "value": "SJ" }{ "label": "Solomon Islands", "value": "SB" }{ "label": "Sierra Leone", "value": "SL" }{ "label": "El Salvador", "value": "SV" }{ "label": "San Marino", "value": "SM" }{ "label": "Somalia", "value": "SO" }{ "label": "Saint Pierre and Miquelon", "value": "PM" }{ "label": "Serbia", "value": "RS" }{ "label": "South Sudan", "value": "SS" }{ "label": "Sao Tome and Principe", "value": "ST" }{ "label": "Suriname", "value": "SR" }{ "label": "Slovakia", "value": "SK" }{ "label": "Slovenia", "value": "SI" }{ "label": "Sweden", "value": "SE" }{ "label": "Eswatini", "value": "SZ" }{ "label": "Sint Maarten (Dutch part)", "value": "SX" }{ "label": "Seychelles", "value": "SC" }{ "label": "Syrian Arab Republic", "value": "SY" }{ "label": "Turks and Caicos Islands", "value": "TC" }{ "label": "Chad", "value": "TD" }{ "label": "Togo", "value": "TG" }{ "label": "Thailand", "value": "TH" }{ "label": "Tajikistan", "value": "TJ" }{ "label": "Tokelau", "value": "TK" }{ "label": "Turkmenistan", "value": "TM" }{ "label": "Timor-Leste", "value": "TL" }{ "label": "Tonga", "value": "TO" }{ "label": "Trinidad and Tobago", "value": "TT" }{ "label": "Tunisia", "value": "TN" }{ "label": "Turkey", "value": "TR" }{ "label": "Tuvalu", "value": "TV" }{ "label": "Taiwan, Province of China", "value": "TW" }{ "label": "Tanzania, United Republic of", "value": "TZ" }{ "label": "Uganda", "value": "UG" }{ "label": "Ukraine", "value": "UA" }{ "label": "United States Minor Outlying Islands", "value": "UM" }{ "label": "Uruguay", "value": "UY" }{ "label": "United States of America", "value": "US" }{ "label": "Uzbekistan", "value": "UZ" }{ "label": "Holy See", "value": "VA" }{ "label": "Saint Vincent and the Grenadines", "value": "VC" }{ "label": "Venezuela, Bolivarian Republic of", "value": "VE" }{ "label": "Virgin Islands, British", "value": "VG" }{ "label": "Virgin Islands, U.S.", "value": "VI" }{ "label": "Viet Nam", "value": "VN" }{ "label": "Vanuatu", "value": "VU" }{ "label": "Wallis and Futuna", "value": "WF" }{ "label": "Samoa", "value": "WS" }{ "label": "Yemen", "value": "YE" }{ "label": "South Africa", "value": "ZA" }{ "label": "Zambia", "value": "ZM" }{ "label": "Zimbabwe", "value": "ZW" }{ "label": "Canary Islands", "value": "IC" }{ "label": "Kosovo", "value": "XK" }`
Service Point	`toServicePoint`	`integer`	Select a value from the drop down menu.
To State	`toState`	`string`	The state of the recipient.
Updated At	`updatedAt`	`string`	Timestamp when the shipment was updated in the shop system. Example: `2022-05-07T15:08:12.152000Z`
City	`city`	`string`	The city of the shipment.
Shipping Method ID	`shippingMethod`	`string`	Select a value from the drop down menu.
Total Order Value	`totalOrderValue`	`string`	Total price of the order (decimal string)
Weight	`weight`	`string`	Total weight of the order (decimal string)
Checkout Payload	`checkoutPayload`	`object`	Object capturing checkout selections made by the end-consumer. Required keys: `sender_address_id` (integer): The sender address ID associated with the order. `shipping_product` (object): The shipping product chosen at checkout. Must include: `code` (string) `name` (string) `selected_functionalities` (array): Functionalities selected for this product. `delivery_method_type` (string): One of "standard_delivery", "nominated_day_delivery", or "same_day_delivery". `delivery_method_data` (object): `delivery_date` (string, date-time): Delivery date required by the end-consumer. `formatted_delivery_date` (string): Human-readable date (e.g., "February 21, 2012"). `parcel_handover_date` (string, date-time): Date the parcel must be handed to the carrier. Example: `{ "sender_address_id": 12345, "shipping_product": { "code": "pd-pickup", "name": "Pickup Point", "selected_functionalities": ["signature", "age_check"] }, "delivery_method_type": "nominated_day_delivery", "delivery_method_data": { "delivery_date": "2025-02-20T09:00:00Z", "formatted_delivery_date": "February 20, 2025", "parcel_handover_date": "2025-02-19T18:00:00Z" } }`
Width	`width`	`string`	Volumetric width (decimal string)
Height	`height`	`string`	Volumetric height (decimal string)
Length	`length`	`string`	Volumetric length (decimal string)
Costs & Tax Details	`customDetails`	`object`	Optional object to provide order-level costs and tax numbers. `discount_granted` (object): Discount granted on the total order `value` (string \| null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)? `currency` (string \| null): ISO 4217 code (e.g., "EUR") `insurance_costs` (object): Amount the order is insured for `value` (string \| null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)? `currency` (string \| null): ISO 4217 code (e.g., "EUR") `freight_costs` (object): Shipping cost of the order `value` (string \| null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)? `currency` (string \| null): ISO 4217 code (e.g., "EUR") `other_costs` (object): Any other costs (e.g., wrapping costs) `value` (string \| null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)? `currency` (string \| null): ISO 4217 code (e.g., "EUR") `tax_numbers` (object \| null): Tax info about sender, receiver, and importer of records `sender` (array of Tax Number): Each has { name (string\|null), country_code (string\|null), value (string\|null) } `receiver` (array of Tax Number): Same structure as sender `importer_of_records` (array of Tax Number): Same structure as sender Example: `{ "discount_granted": { "value": "3.99", "currency": "EUR" }, "insurance_costs": { "value": "2.50", "currency": "EUR" }, "freight_costs": { "value": "5.00", "currency": "EUR" }, "other_costs": { "value": null, "currency": null }, "tax_numbers": { "sender": [{ "name": "VAT", "country_code": "NL", "value": "NL987654321B02" }], "receiver": [], "importer_of_records": [] } }`

Authentication#

Sendcloud uses API keys for authentication. When you connect your Sendcloud account, Pipedream securely stores the keys so you can easily authenticate to Sendcloud APIs in both code and no-code steps.

To retrieve your API Keys,