ExploreConnectDocsChangelogPricingTemplatesPartnersString
Sign in
Sign up
← Paazl

Save Order with Paazl API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Save Order with the Paazl API
No credit card required
Intro to Pipedream
▶
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers ♥ Pipedream

Getting Started

Create a workflow to Save Order with the Paazl API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Save Order action
    1. Connect your Paazl account
    2. Configure Order Reference
    3. Configure Consignee
    4. Optional- Configure Customs Value
    5. Optional- Configure Insured Value
    6. Optional- Configure COD Value
    7. Optional- Configure Description
    8. Optional- Configure Requested Delivery Date
    9. Optional- Configure Products
    10. Optional- Configure Invoice Number
    11. Optional- Configure Invoice Date
    12. Optional- Configure Return Address
    13. Optional- Configure Sender
    14. Configure Shipping
    15. Optional- Configure Weight
    16. Optional- Configure Additional Instructions
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Save Order with Paazl API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Paazl
 
Try it
Save Order with Paazl API on New Submission from Typeform API
Typeform + Paazl
 
Try it
Save Order with Paazl API on New Submission (Instant) from Jotform API
Jotform + Paazl
 
Try it
Save Order with Paazl API on New Scheduled Tasks from Pipedream API
Pipedream + Paazl
 
Try it
Save Order with Paazl API on New Download Counts from npm API
npm + Paazl
 
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.

Save Order on Paazl
Description:Saves an order's most important information to the Paazl database once a customer has paid for their purchase. [See the documentation](https://support.paazl.com/hc/en-us/articles/360008633973-REST-API-reference#/Order/saveOrderUsingPOST)
Version:0.0.2
Key:paazl-save-order

Code

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

export default {
  key: "paazl-save-order",
  name: "Save Order",
  description: "Saves an order's most important information to the Paazl database once a customer has paid for their purchase. [See the documentation](https://support.paazl.com/hc/en-us/articles/360008633973-REST-API-reference#/Order/saveOrderUsingPOST)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    reference: {
      propDefinition: [
        app,
        "reference",
      ],
      label: "Order Reference",
      description: "Your own order reference for a purchase transaction. Must be unique within the webshop.",
    },
    consignee: {
      propDefinition: [
        app,
        "consignee",
      ],
    },
    customsValue: {
      propDefinition: [
        app,
        "customsValue",
      ],
    },
    insuredValue: {
      propDefinition: [
        app,
        "insuredValue",
      ],
    },
    codValue: {
      propDefinition: [
        app,
        "codValue",
      ],
    },
    description: {
      propDefinition: [
        app,
        "orderDescription",
      ],
    },
    requestedDeliveryDate: {
      propDefinition: [
        app,
        "requestedDeliveryDate",
      ],
    },
    products: {
      propDefinition: [
        app,
        "products",
      ],
    },
    invoiceNumber: {
      propDefinition: [
        app,
        "invoiceNumber",
      ],
    },
    invoiceDate: {
      propDefinition: [
        app,
        "invoiceDate",
      ],
    },
    returnProp: {
      propDefinition: [
        app,
        "returnProp",
      ],
    },
    sender: {
      propDefinition: [
        app,
        "sender",
      ],
    },
    shipping: {
      propDefinition: [
        app,
        "shipping",
      ],
    },
    weight: {
      propDefinition: [
        app,
        "orderWeight",
      ],
    },
    additionalInstruction: {
      propDefinition: [
        app,
        "additionalInstruction",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      reference,
      consignee,
      customsValue,
      insuredValue,
      codValue,
      description,
      requestedDeliveryDate,
      products,
      invoiceNumber,
      invoiceDate,
      returnProp,
      sender,
      shipping,
      weight,
      additionalInstruction,
    } = this;

    const response = await app.saveOrder({
      $,
      data: {
        reference,
        consignee: utils.parseJson(consignee),
        customsValue: utils.parseJson(customsValue),
        insuredValue: utils.parseJson(insuredValue),
        codValue: utils.parseJson(codValue),
        description,
        requestedDeliveryDate,
        products: utils.parseArray(products),
        invoiceNumber,
        invoiceDate,
        return: utils.parseJson(returnProp),
        sender: utils.parseJson(sender),
        shipping: utils.parseJson(shipping),
        weight: weight
          ? parseFloat(weight)
          : undefined,
        additionalInstruction,
      },
    });

    $.export("$summary", `Successfully saved order information for reference: ${reference}`);
    return response || {
      success: true,
    };
  },
};

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.
LabelPropTypeDescription
PaazlappappThis component uses the Paazl app.
Order Referencereferencestring

Your own order reference for a purchase transaction. Must be unique within the webshop.

Consigneeconsigneeobject

Contains details of the party to which an order is shipped.

Fields:

  • companyName (string): The name of a company to which an order is shipped.
    Example: "Bonn Mac Tosch"
  • vatNumber (string): The VAT number of the receiver.
    Example: "vat-123456789"
  • email (string): The email address of the person to whom an order is shipped.
    Example: "freddie.kwiksilver@konningin.org"
  • name (string): The name of the person to whom an order is shipped.
    Example: "Friederich Feuerstein"
  • other (string): Additional details used to identify the person to whom an order is shipped.
    Example: "Logistik Manager"
  • phone (string): The phone number of the person to whom an order is shipped.
    Example: "+31-20-7736303"
  • locale (string): Specifies the language of the email templates used for track & trace notifications.
    Format: {language}_{country} (e.g., fr_FR)
  • address (object): Contains details of the address to which an order is shipped.
    Address Fields:
    • city (string): The city or town. Example: "Bonn"
    • country (string): ISO 3166-2 code. Example: "DE"
    • postalCode (string): Postal code. Example: "53111"
    • province (string): Province/state code. Example: "NW"
    • street (string): Street name. Example: "Am Hauptbahnhof"
    • streetLines (array): Additional street lines.
    • houseNumber (integer): House number. Example: 9
    • houseNumberExtension (string): House number extension. Example: "-A"

Example:

{
  "companyName": "Bonn Mac Tosch",
  "vatNumber": "vat-123456789",
  "email": "freddie.kwiksilver@konningin.org",
  "name": "Friederich Feuerstein",
  "other": "Logistik Manager",
  "phone": "+31-20-7736303",
  "locale": "fr_FR",
  "address": {
    "city": "Bonn",
    "country": "DE",
    "postalCode": "53111",
    "province": "NW",
    "street": "Am Hauptbahnhof",
    "streetLines": ["Am Hauptbahnhof 9"],
    "houseNumber": 9,
    "houseNumberExtension": "-A"
  }
}
Customs ValuecustomsValueobject

The total monetary value for customs purposes.

Fields:

  • value (number): The monetary value of an order for customs purposes.
    Example: 40.2
  • currency (string): The ISO 4217 code for the currency.
    The default code is "EUR".
    Example: "USD"
  • description (string): The description of the customs value.
    Example: "Customs value description"

Example:

{
  "value": 40.2,
  "currency": "USD",
  "description": "Customs value description"
}
Insured ValueinsuredValueobject

The amount for which this order is insured by the carrier against loss, damage, or accident during transport.

Fields:

  • value (number): The amount of insurance coverage requested from the carrier.
    Example: 500.0
  • currency (string): The ISO 4217 code for the currency.
    The default code is "EUR".
    Example: "USD"
  • description (string): The description of the insured value.
    Example: "Insured value description"

Example:

{
  "value": 500.0,
  "currency": "USD",
  "description": "Insured value description"
}
COD ValuecodValueobject

The amount that a consignee has to pay before receiving the "Cash On Delivery" consignment.

Fields:

  • value (number): The amount that has to be paid by receiver before receiving the goods.
    Example: 40.2
  • currency (string): The ISO 4217 code for the currency.
    The default code is "EUR".
    Example: "USD"
  • description (string): The description of the COD value.
    Example: "COD value description"

Example:

{
  "value": 40.2,
  "currency": "USD",
  "description": "COD value description"
}
Descriptiondescriptionstring

A general description of the contents of a shipment

Requested Delivery DaterequestedDeliveryDatestring

The date on which a customer has requested that an order be delivered (format: YYYY-MM-DD)

Productsproductsstring[]

Contains objects representing the products making up an order.

Fields:

  • height (integer): The height of a product, in centimeters (cm).
    Example: 10
  • length (integer): The length of a product, in centimeters (cm).
    Example: 30
  • unitPrice (object): The value of a product.
    • value (number): The monetary value of a product. Example: 40.2
    • currency (string): The ISO 4217 code for the currency. Default: "EUR". Example: "USD"
    • description (string): The description of the product. Example: "Zhitomir socks"
  • quantity (integer, required): The number of items of a product in a shipment.
    Example: 7
  • volume (number): The volume of a product, including packaging, in cubic meters (m³).
    Example: 0.015625
  • weight (number): The weight of a product, in kilograms (kg).
    Example: 100
  • width (integer): The width of a product, in centimeters (cm).
    Example: 20
  • countryOfManufacture (string): The ISO 3166-2 code for the country in which a product was manufactured.
    Example: "DE"
  • description (string): A description of the contents of a specific product.
    Example: "Zhitomir socks"
  • hsTariffCode (string): The import Harmonized System code of a product.
    Example: "62034231"
  • skuCode (string): The SKU code of a product.
    Example: "8754-124-990" or "KS944RUR"

Example:

[
  {
    "height": 10,
    "length": 30,
    "unitPrice": {
      "value": 40.2,
      "currency": "USD",
      "description": "Zhitomir socks"
    },
    "quantity": 7,
    "volume": 0.015625,
    "weight": 100,
    "width": 20,
    "countryOfManufacture": "DE",
    "description": "Zhitomir socks",
    "hsTariffCode": "62034231",
    "skuCode": "8754-124-990"
  }
]
Invoice NumberinvoiceNumberstring

The invoice number of an order (sometimes required for international shipments)

Invoice DateinvoiceDatestring

The invoice date of an order (format: YYYY-MM-DD)

Return AddressreturnPropobject

Contains the details of an address to which an order is returned.

Fields:

  • description (string): The description of the return address.
    Example: "Return address description"
  • name (string): The name of the party to which an order is returned.
    Example: "A'dam Mac Tosch"
  • address (object): Contains details of the address to which an order is returned.
    • city (string, required if address is provided): The city or town.
      Example: "Bonn"
    • country (string): ISO 3166-2 code for the country.
      Example: "DE"
    • postalCode (string): Postal code.
      Example: "53111"
    • province (string): Last 2 letters of the ISO 3166-2 code for the province/state.
      Example: "NW"
    • street (string): Name of the street.
      Example: "Jacob Bontousplaats"
    • streetLines (array of strings): Street name and house number, one or more strings.
      Example: ["Jacob Bontiusplaats 9", "Unit 580"]
    • houseNumber (integer): House number.
      Example: 9
    • houseNumberExtension (string): House number extension (e.g., "-A").
      Example: "-A"

Example:

{
  "description": "Return address description",
  "name": "A'dam Mac Tosch",
  "address": {
    "city": "Bonn",
    "country": "DE",
    "postalCode": "53111",
    "province": "NW",
    "street": "Jacob Bontiusplaats",
    "streetLines": ["Jacob Bontiusplaats 9", "Unit 580"],
    "houseNumber": 9,
    "houseNumberExtension": "-A"
  }
}
Sendersenderobject

Contains the details of the address from which an order is shipped.

Fields:

  • description (string): The description of the sender address.
    Example: "Sender address description"
  • name (string): The name of the party that shipped an order.
    Example: "A'dam Mac Tosch"
  • address (object, required if provided): Contains details of the address from which an order is shipped.
    • city (string, required if address is provided): The city or town from which an order is shipped.
      Example: "Bonn"
    • country (string): ISO 3166-2 code for the country.
      Example: "DE"
    • postalCode (string): Postal code.
      Example: "53111"
    • province (string): Last 2 letters of the ISO 3166-2 code for the province/state.
      Example: "NW"
    • street (string): Name of the street.
      Example: "John Plagis Avenue"
    • streetLines (array of strings): Street name and house number, one or more strings.
      Example: ["6 John Plagis Avenue", "Around the corner"]
    • houseNumber (integer): House number.
      Example: 6
    • houseNumberExtension (string): House number extension (e.g., "-A").
      Example: "-A"

Note:
If not provided, the default value is the address specified in your web app account under Settings > Account > My address book > Sender address.

Example:

{
  "description": "Sender address description",
  "name": "A'dam Mac Tosch",
  "address": {
    "city": "Bonn",
    "country": "DE",
    "postalCode": "53111",
    "province": "NW",
    "street": "John Plagis Avenue",
    "streetLines": ["6 John Plagis Avenue", "Around the corner"],
    "houseNumber": 6,
    "houseNumberExtension": "-A"
  }
}
Shippingshippingobject

Contains information on the shipping option selected by a customer.

Fields:

  • option (string, required): A shipping option's Paazl identifier.
    Example: "AVG"

  • pickupLocation (object, optional): If your customer selected a pickup location at checkout, this object contains information on that location.

    • description (string, optional): The description of the pickup location.
      Example: "Pickup location description"
    • accountNumber (string, optional): An account number that a carrier can issue to customers for managing delivery of their parcel to a collection point.
    • code (string, required if pickupLocation is provided): A carrier's unique code for a pickup location.
      Example: "NOP12345"

  • contract (string, optional): The identification code of your carrier contract for an outbound shipment.
    Example: "XYZ123"

  • returnContract (string, optional): The identification code of your carrier contract for a return shipment.
    Example: "321ZYX"

  • packageCount (integer, optional): The number of packages in a shipment.
    Example: 3

  • multiPackageShipment (boolean, optional): If true, Paazl will treat the shipment as consolidated.
    Example: false

Example:

{
  "option": "AVG",
  "pickupLocation": {
    "description": "Pickup location description",
    "accountNumber": "123456789",
    "code": "NOP12345"
  },
  "contract": "XYZ123",
  "returnContract": "321ZYX",
  "packageCount": 3,
  "multiPackageShipment": false
}
Weightweightstring

The total weight in kilograms (kg) of an order, including packaging

Additional InstructionsadditionalInstructionstring

Additional instructions for the delivery of an order

Authentication

Paazl uses OAuth authentication. When you connect your Paazl account, Pipedream will open a popup window where you can sign into Paazl and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Paazl API.

Pipedream requests the following authorization scopes when you connect your account:

About Paazl

Shipping software for the best delivery experience

More Ways to Use Paazl

Actions

Create Checkout Access Token with the Paazl API

Returns an access token for a checkout session. This enables the Paazl checkout widget to access Paazl resources. See the documentation

 
Try it
Create Shipment For Order with the Paazl API

Generates a shipment at the carrier for the shipping option specified in POST order. See the documentation

 
Try it
Delete Order with the Paazl API

Deletes an order. See the documentation

 
Try it
Get Checkout Session Data with the Paazl API

Gets your reference for a checkout session. See the documentation

 
Try it
Get Home Delivery Shipping Options with the Paazl API

Contains shipping options for your checkout page. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,800+
apps by most popular

Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
abcdefghijklmnopqrstuvwxyz#
Pipedream, Inc. — San Francisco, CA
AboutTwitterDocsCommunityTermsPrivacyTry String