ShipTown icon

ShipTown

Consume ShipTown API

Actions20

Overview

This node integrates with the ShipTown API to manage various resources such as products, orders, activities, inventory, warehouses, users, and data collectors. Specifically for the Product - Create operation, it allows users to create a new product in the ShipTown system by sending product details via the API.

Common scenarios where this node is beneficial include:

  • Automating product creation workflows when syncing product catalogs from other systems.
  • Integrating ShipTown product management into broader automation pipelines.
  • Quickly adding new products programmatically without manual entry in the ShipTown dashboard.

Example use case: Automatically creating a new product in ShipTown whenever a new item is added to an e-commerce platform's inventory system.

Properties

Name Meaning
Additional Fields A collection of optional additional properties for the product, provided as a JSON object.

The "Additional Fields" property supports one option:

  • Properties: A JSON string representing extra product attributes to be sent to the API during creation.

Example of "Properties" JSON:

{
  "sku": "12345",
  "name": "New Product",
  "price": 19.99,
  "weight": 1.5
}

Output

The node outputs the JSON response returned by the ShipTown API after creating the product. This typically includes the newly created product's details such as its ID, name, SKU, and any other metadata returned by the API.

The output is structured as an array of JSON objects, each corresponding to an input item processed. There is no binary data output.

Dependencies

  • Requires an active connection to the ShipTown API using an API key credential configured in n8n.
  • The node uses the base URL and authentication credentials set up in the node's credential configuration.
  • No additional external dependencies are required beyond the ShipTown API access.

Troubleshooting

  • Invalid JSON in Additional Fields: If the JSON string in "Properties" is malformed, the node will throw a parsing error. Ensure valid JSON syntax.
  • Authentication Errors: If the API key or domain is incorrect or missing, requests will fail with authentication errors. Verify credentials in n8n.
  • API Request Failures: Network issues or invalid product data may cause the API to reject the request. Check the error message returned by the API for details.
  • Missing Required Fields: Although the node allows flexible additional fields, some required product attributes might be mandatory on the API side. Confirm required fields in ShipTown API documentation.

Links and References

Discussion