avanta icon

avanta

Consume avanta API

Actions57

Servicecenter - Backorder → Create or Update

AI-generated

Overview

This node interacts with the 'Servicecenter - Backorder' resource to create or update backorder records. It is useful in scenarios where businesses need to manage backorders by adding or updating customer backorder information, including detailed backorder positions and associated document files. For example, it can be used to automate the creation of backorders from customer orders or update existing backorders with new information or status changes.

Use Case Examples

  1. Creating a new backorder for a customer with multiple backorder positions and associated document files.
  2. Updating an existing backorder with additional comments, custom fields, or status updates.

Properties

Name Meaning
Request Options Options to configure the API request such as enabling debug mode, ignoring SSL issues, and setting request timeout.
Return to Webhook Whether to return the response to a webhook (only for create operation).
Use Bulk API Whether to use the bulk API for processing multiple items (applicable to create operation).
Dataflow ID Optional override for the dataflow ID, automatically read from webhook input if not set (applicable when using bulk API).
Customer ID ID of the customer for the backorder.
Company ID ID of the company associated with the backorder.
Customer Order ID Order ID provided by the customer.
Customer Backorder ID Backorder ID provided by the customer.
Backorder Positions Type Method to add backorder positions, either by mapping fields or using raw JSON.
Backorder Positions Collection of backorder positions with detailed fields such as item position, name, price, quantity, SKU, subtotal, and additional custom fields (shown when 'Fields Below' is selected).
Backorder Positions JSON Raw JSON input to add backorder positions (shown when 'JSON' is selected).
Document Files Backorder document files that can be added manually or provided as a JSON array.
Additional Fields Additional optional fields for the backorder such as backorder date, internal backorder ID, comments, custom dates, prices, texts, extension attributes, status, external ID, and billing/shipping details.

Output

JSON

  • id - Internal backorder ID assigned by the system
  • customer_id - ID of the customer associated with the backorder
  • company_id - ID of the company associated with the backorder
  • customer_orderid - Order ID provided by the customer
  • customer_backorderid - Backorder ID provided by the customer
  • backorder_positions - Array of backorder position objects with detailed item information
  • document_files - Array of document files associated with the backorder
  • status - Status of the backorder
  • backorder_date - Date of the backorder
  • comment - Comment for the backorder
  • custom_date1 - Custom date field 1
  • custom_date2 - Custom date field 2
  • custom_price1 - Custom price field 1
  • custom_price2 - Custom price field 2
  • custom_text1 - Custom text field 1
  • custom_text2 - Custom text field 2
  • extension_attributes - Array of extension attributes associated with the backorder
  • external_id - External backorder ID
  • billing_city - Billing city for the backorder
  • billing_company - Billing company for the backorder
  • billing_country - Billing country for the backorder
  • billing_email - Billing email for the backorder
  • billing_name - Billing name for the backorder
  • billing_street - Billing street for the backorder
  • billing_telephone - Billing telephone for the backorder
  • billing_zip - Billing zip code for the backorder
  • shipping_city - Shipping city for the backorder
  • shipping_company - Shipping company for the backorder
  • shipping_country - Shipping country for the backorder
  • shipping_email - Shipping email for the backorder
  • shipping_name - Shipping name for the backorder
  • shipping_street - Shipping street for the backorder
  • shipping_telephone - Shipping telephone for the backorder
  • shipping_zip - Shipping zip code for the backorder

Dependencies

  • An API key credential for authenticating with the Avanta API

Troubleshooting

  • Ensure required fields such as Customer ID, Company ID, Customer Order ID, and Customer Backorder ID are provided to avoid validation errors.
  • If using JSON input for backorder positions or document files, ensure the JSON is correctly formatted to prevent parsing errors.
  • Enable debug mode to get detailed API request information if the node does not behave as expected.
  • If SSL certificate validation issues occur, consider enabling the option to ignore SSL issues, but be aware of security risks.

Links

Discussion