Create Order with Shopware API

Pipedream makes it easy to connect APIs for Shopware and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Order with the Shopware 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 Order with the Shopware API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Order action
1. Connect your Shopware account
2. Select a Billing Address ID
3. Select a Currency ID
4. Select a Sales Channel ID
5. Select a State ID
6. Configure Order Date Time
7. Configure Price Object
8. Configure Shipping Costs Object
9. Configure Currency Object
10. Configure Currency Factor
11. Configure Item Rounding
12. Configure Total Rounding
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

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 Order on Shopware

Description:Create a new order. [See the documentation](https://shopware.stoplight.io/docs/admin-api/52ce9936f6ea4-create-a-new-order-resources)

Version:0.0.1

Key:shopware-create-order

View on GitHub

Code#

import { parseObject } from "../../common/utils.mjs";
import shopware from "../../shopware.app.mjs";

export default {
  key: "shopware-create-order",
  name: "Create Order",
  description: "Create a new order. [See the documentation](https://shopware.stoplight.io/docs/admin-api/52ce9936f6ea4-create-a-new-order-resources)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    shopware,
    billingAddressId: {
      propDefinition: [
        shopware,
        "customerAddressId",
      ],
      label: "Billing Address ID",
      description: "The ID of the billing address to use for the order",
    },
    currencyId: {
      propDefinition: [
        shopware,
        "currencyId",
      ],
    },
    salesChannelId: {
      propDefinition: [
        shopware,
        "salesChannelId",
      ],
    },
    stateId: {
      propDefinition: [
        shopware,
        "stateId",
        () => ({
          type: "order.state",
        }),
      ],
    },
    orderDateTime: {
      type: "string",
      label: "Order Date Time",
      description: "The date and time the order was created",
    },
    priceObject: {
      type: "object",
      label: "Price Object",
      description: "Price object to use for the order. Example: `{ \"netPrice\": 1.00, \"totalPrice\": 1.00, \"positionPrice\": 1.00, \"rawTotal\": 1.00, \"taxStatus\": \"Free\", \"calculatedTaxes\": {}, \"taxRules\": {} }` [See the documentation](https://shopware.stoplight.io/docs/admin-api/52ce9936f6ea4-create-a-new-order-resources) for more information.",
    },
    shippingCostsObject: {
      type: "object",
      label: "Shipping Costs Object",
      description: "Shipping costs object to use for the order. Example: `{ \"unitPrice\": 1.00, \"totalPrice\": 1.00, \"quantity\": 1, \"calculatedTaxes\": {}, \"taxRules\": {} }` [See the documentation](https://shopware.stoplight.io/docs/admin-api/52ce9936f6ea4-create-a-new-order-resources) for more information.",
    },
    currencyObject: {
      type: "object",
      label: "Currency Object",
      description: "Currency object to use for the order. Example: `{ \"factor\": 1.0, \"symbol\": \"€\", \"isoCode\": \"EUR\", \"itemRounding\": { \"decimals\": 2, \"interval\": 1.0, \"roundForNet\": true }, \"totalRounding\": { \"decimals\": 2, \"interval\": 1.0, \"roundForNet\": true } }` [See the documentation](https://shopware.stoplight.io/docs/admin-api/52ce9936f6ea4-create-a-new-order-resources) for more information.",
    },
    currencyFactor: {
      type: "string",
      label: "Currency Factor",
      description: "Rate at which currency is exchanged",
    },
    itemRounding: {
      type: "object",
      label: "Item Rounding",
      description: "The rounding method to use for the order items. Example: {\"extensions\":[],\"decimals\":2,\"interval\":0.01,\"roundForNet\":true}",
    },
    totalRounding: {
      type: "object",
      label: "Total Rounding",
      description: "The rounding method to use for the order total. Example: {\"extensions\":[],\"decimals\":2,\"interval\":0.01,\"roundForNet\":true}",
    },
  },
  async run({ $ }) {
    const { data } = await this.shopware.createOrder({
      $,
      params: {
        _response: "json",
      },
      data: {
        billingAddressId: this.billingAddressId,
        currencyId: this.currencyId,
        salesChannelId: this.salesChannelId,
        stateId: this.stateId,
        orderDateTime: this.orderDateTime,
        price: parseObject(this.priceObject),
        shippingCosts: parseObject(this.shippingCostsObject),
        currencyFactor: this.currencyFactor && parseFloat(this.currencyFactor),
        currency: parseObject(this.currency),
        itemRounding: parseObject(this.itemRounding),
        totalRounding: parseObject(this.totalRounding),
      },
    });

    $.export("$summary", `Successfully created order with ID: ${data.id}`);
    return data;
  },
};

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
Shopware	`shopware`	`app`	This component uses the Shopware app.
Billing Address ID	`billingAddressId`	`string`	Select a value from the drop down menu.
Currency ID	`currencyId`	`string`	Select a value from the drop down menu.
Sales Channel ID	`salesChannelId`	`string`	Select a value from the drop down menu.
State ID	`stateId`	`string`	Select a value from the drop down menu.
Order Date Time	`orderDateTime`	`string`	The date and time the order was created
Price Object	`priceObject`	`object`	Price object to use for the order. Example: `{ "netPrice": 1.00, "totalPrice": 1.00, "positionPrice": 1.00, "rawTotal": 1.00, "taxStatus": "Free", "calculatedTaxes": {}, "taxRules": {} }` See the documentation for more information.
Shipping Costs Object	`shippingCostsObject`	`object`	Shipping costs object to use for the order. Example: `{ "unitPrice": 1.00, "totalPrice": 1.00, "quantity": 1, "calculatedTaxes": {}, "taxRules": {} }` See the documentation for more information.
Currency Object	`currencyObject`	`object`	Currency object to use for the order. Example: `{ "factor": 1.0, "symbol": "€", "isoCode": "EUR", "itemRounding": { "decimals": 2, "interval": 1.0, "roundForNet": true }, "totalRounding": { "decimals": 2, "interval": 1.0, "roundForNet": true } }` See the documentation for more information.
Currency Factor	`currencyFactor`	`string`	Rate at which currency is exchanged
Item Rounding	`itemRounding`	`object`	The rounding method to use for the order items. Example: {"extensions":[],"decimals":2,"interval":0.01,"roundForNet":true}
Total Rounding	`totalRounding`	`object`	The rounding method to use for the order total. Example: {"extensions":[],"decimals":2,"interval":0.01,"roundForNet":true}

Authentication#

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

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