Shopware icon

Shopware

Shopware

Actions778

Number Range → Create Number Range

AI-generated

Overview

This node operation allows users to create a new Number Range resource in the Shopware system. It is useful for scenarios where you need to define custom number ranges for entities such as orders, invoices, or other documents within Shopware. For example, you can create a number range with a specific pattern, start value, and associate it with sales channels or states.

Use Case Examples

  1. Creating a number range for order numbers with a specific prefix and start value.
  2. Defining a global number range for invoices with a custom pattern and description.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the number range.
Type Id Identifier for the type of number range.
Global Boolean flag indicating if the number range is global.
Name Name of the number range.
Description Description of the number range.
Pattern Pattern used for the number range.
Start Starting number for the number range.
Custom Fields Custom fields as JSON object for additional data.
Created At Creation timestamp of the number range.
Updated At Last update timestamp of the number range.
Translated Translated fields as JSON object.
Type Type details of the number range as JSON object.
Number Range Sales Channels Sales channels associated with the number range as JSON array.
State State details of the number range as JSON object.
Request Options Additional request options such as batching, SSL settings, proxy, and timeout.

Output

JSON

  • id - Unique identifier of the created number range.
  • typeId - Type identifier of the created number range.
  • global - Indicates if the number range is global.
  • name - Name of the created number range.
  • description - Description of the created number range.
  • pattern - Pattern used in the number range.
  • start - Starting number of the number range.
  • customFields - Custom fields associated with the number range.
  • createdAt - Creation timestamp of the number range.
  • updatedAt - Last update timestamp of the number range.
  • translated - Translated fields of the number range.
  • type - Type details of the number range.
  • numberRangeSalesChannels - Sales channels linked to the number range.
  • state - State details of the number range.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields (Id, Type Id, Global, Name, Pattern, Start) are provided to avoid validation errors.
  • If the API returns authentication errors, verify the API key credential and base URL configuration.
  • For JSON fields (Custom Fields, Translated, Type, Number Range Sales Channels, State), ensure valid JSON format to prevent parsing errors.
  • Timeout or network errors can be mitigated by adjusting the Request Options such as timeout and proxy settings.

Discussion