When you configure an export, import, other type of flow step using the prebuilt JTL connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the JTL API documentation. You can also create a composite endpoint for this application in HTTP mode.
|
Resource |
API endpoint |
Export |
Import |
|---|---|---|---|
|
Account |
Create seller |
X |
|
|
Login SCX account |
X |
||
|
Seller |
X |
||
|
Unlink seller from channel |
X |
||
|
Update seller |
X |
||
|
Accounting data |
Query accounting data |
X |
|
|
App registration |
Fetch registration status |
X |
|
|
Register app |
X |
||
|
Register a multi-instance app |
X |
||
|
Attributes |
Category attributes |
X |
|
|
Delete category attribute by ID |
X |
||
|
Delete category attributes |
X |
||
|
Delete global attribute |
X |
||
|
Delete seller attribute |
X |
||
|
Get category attributes |
X |
||
|
Get global attributes |
X |
||
|
Get seller attributes |
X |
||
|
Global attributes |
X |
||
|
Seller attributes |
X |
||
|
Bill of materials components command |
Delete a bill of materials item from a bill of materials |
X |
|
|
Delete a bill of materials operation from a bill of materials |
X |
||
|
Bill of materials components query |
Retrieve a bill of materials item by its ID |
X |
|
|
Retrieve a bill of materials operation by its ID |
X |
||
|
Bills of materials command |
Delete a bill of materials |
X |
|
|
Bills of materials query |
Retrieve a bill of materials by its ID |
X |
|
|
Bin location management command |
Activate a bin location, making it available for operations |
X |
|
|
Create a new bin location in a warehouse |
X |
||
|
Deactivate a bin location, making it available for operations |
X |
||
|
Delete a bin location from the warehouse |
X |
||
|
Lock a bin location for available stock, preventing it from being used for stock allocation |
X |
||
|
Lock a bin location, preventing stock movements |
X |
||
|
Unlock a bin location for available stock, allowing it to be used for stock allocation |
X |
||
|
Update metadata of an existing bin location (name |
X |
||
|
Bin location management query |
Return a single bin location by its ID |
X |
|
|
Return all available bin location statuses |
X |
||
|
Return all available bin location types |
X |
||
|
Cancellation reason |
Query cancellation reasons |
X |
|
|
Query invoice cancellation reasons |
X |
||
|
Query refund cancellation reasons |
X |
||
|
Query sales invoice correction cancellation reasons |
X |
||
|
Categories |
Get category tree |
X |
|
|
Update category tree |
X |
||
|
Category command |
Create a new category |
X |
|
|
Delete a category |
X |
||
|
Update a new category |
X |
||
|
Category query |
Deliver a single category |
X |
|
|
Channel |
Generate MFA PIN |
X |
|
|
List all sellerids |
X |
||
|
Status |
X |
||
|
Update channel |
X |
||
|
Channel list |
X |
||
|
Color codes |
Query color codes |
X |
|
|
Company |
Query companies |
X |
|
|
Company details query |
Deliver a single company |
X |
|
|
Configuration |
Create number range |
X |
|
|
Delete number range |
X |
||
|
Get number range |
X |
||
|
Get number ranges |
X |
||
|
Number range increment |
X |
||
|
Number range preview |
X |
||
|
Update number range |
X |
||
|
Copy item details command |
Copy item details |
X |
|
|
Country query |
Definition to query countries |
X |
|
|
Create command |
Create a new bill of materials for a production item, including its components |
X |
|
|
Create a new bill of materials item for a bill of materials operation |
X |
||
|
Create a new bill of materials operation for a bill of materials, including its items |
X |
||
|
Create a new lot size for a production item |
X |
||
|
Create a new production item, including its bills of materials with their components |
X |
||
|
Credit note |
Mail credit note |
X |
|
|
PDF credit note |
X |
||
|
Print credit note |
X |
||
|
Customer |
Trigger customer workflow |
X |
|
|
Customer category |
Create customer category |
X |
|
|
Delete customer category |
X |
||
|
Get customer category |
X |
||
|
Query customer categories |
X |
||
|
Update customer category |
X |
||
|
Customer domain command |
Create a customer |
X |
|
|
Update a customer |
X |
||
|
Customer domain query |
Deliver a single customer by its ID |
X |
|
|
Customer group |
Create customer group |
X |
|
|
Delete customer group |
X |
||
|
Get customer group |
X |
||
|
Query customer groups |
X |
||
|
Update customer group |
X |
||
|
Delivery note |
Get delivery note |
X |
|
|
Get delivery note packages |
X |
||
|
Mail delivery note |
X |
||
|
Patch package data |
X |
||
|
PDF delivery note |
X |
||
|
Post package data for delivery note |
X |
||
|
Print delivery note |
X |
||
|
Query delivery notes |
X |
||
|
Trigger delivery note workflow |
X |
||
|
Duplicate item command |
Create one or more duplicates of an existing item with specified duplication options |
X |
|
|
Events |
Acknowledge events |
X |
|
|
Seller events |
X |
||
|
Acknowledge events |
X |
||
|
Channel events |
X |
||
|
Extensibility |
Create extension |
X |
|
|
Delete extension |
X |
||
|
Get extension |
X |
||
|
Get extensions |
X |
||
|
Put extension manifest |
X |
||
|
Update extension |
X |
||
|
Features |
Get features |
X |
|
|
Info |
Get status |
X |
|
|
Invoice |
Get invoice |
X |
|
|
Mail invoice |
X |
||
|
PDF invoice |
X |
||
|
Print invoice |
X |
||
|
Query invoice line items |
X |
||
|
Query invoice workflow events |
X |
||
|
Query invoices |
X |
||
|
Trigger invoice workflow event |
X |
||
|
Trigger invoice workflow |
X |
||
|
Invoicing command |
Exclude marketplace invoice correction PDFs from upload |
X |
|
|
Exclude marketplace invoice corrections from upload |
X |
||
|
Exclude marketplace invoice PDFs from upload |
X |
||
|
Reset the upload counter for marketplace invoice corrections |
X |
||
|
Reset PDF generation for marketplace invoices/invoice corrections |
X |
||
|
Item |
Query availabilities |
X |
|
|
Query conditions |
X |
||
|
Query responsible persons |
X |
||
|
Query shipping classes |
X |
||
|
Query tax classes |
X |
||
|
Itemdetails command |
Add a new value to an existing item variation |
X |
|
|
Add a new variation (e.g. |
X |
||
|
Add supplier information to an existing regular item |
X |
||
|
Create a new regular item with all specified properties |
X |
||
|
Modify an existing regular item with all specified properties |
X |
||
|
Remove a specific value from an item variation |
X |
||
|
Remove an existing variation from an item |
X |
||
|
Itemdetails query |
Retrieve a single article by its ID, including all sub-elements |
X |
|
|
Languages command |
Activate a language in the system |
X |
|
|
Deactivate a language in the system |
X |
||
|
Languages query |
Query for activated languages |
X |
|
|
Login |
Login |
X |
|
|
Logout |
Logout |
X |
|
|
Lot sizes query |
Retrieve a lot size by its ID |
X |
|
|
Meta |
Payment rules |
X |
|
|
Shipping rules |
X |
||
|
Category attributes |
X |
||
|
Category tree |
X |
||
|
Category tree version list |
X |
||
|
Channel attributes |
X |
||
|
Channel payment |
X |
||
|
Channel price types |
X |
||
|
Channel seller attributes |
X |
||
|
Channel shipping |
X |
||
|
Request seller attributes update |
X |
||
|
Notification |
Notification |
X |
|
|
Offer |
Mark listing as failed |
X |
|
|
Mark listing in progress |
X |
||
|
Offer successful listed |
X |
||
|
Mail offer |
X |
||
|
PDF offer |
X |
||
|
Print offer |
X |
||
|
Create offer |
X |
||
|
End offer |
X |
||
|
Update offer |
X |
||
|
Update price |
X |
||
|
Update stock |
X |
||
|
Upload files |
X |
||
|
Upload picture |
X |
||
|
Offers command |
Delete the specified marketplace offers |
X |
|
|
Remove the item assignment from the specified marketplace offers |
X |
||
|
Sets the maximum stock quantity for the specified marketplace offers |
X |
||
|
Sets the minimum stock quantity for the specified marketplace offers |
X |
||
|
Triggers stock synchronisation for the specified marketplace offers |
X |
||
|
On hold reason |
Query on hold reasons |
X |
|
|
Order |
Accept cancellation request |
X |
|
|
Create orders |
X |
||
|
Deny cancellation request |
X |
||
|
Invoice |
X |
||
|
Refund processing result |
X |
||
|
Request order cancellation |
X |
||
|
Status update |
X |
||
|
Update order address list |
X |
||
|
Upload invoice |
X |
||
|
Accept cancellation request |
X |
||
|
Deny cancellation request |
X |
||
|
Invoice |
X |
||
|
Order confirm |
X |
||
|
Request order cancellation |
X |
||
|
Return |
X |
||
|
Send refund |
X |
||
|
Set payment |
X |
||
|
Shipping |
X |
||
|
Upload invoice |
X |
||
|
Orders command |
Exclude marketplace order cancellation uploads from upload |
X |
|
|
Exclude marketplace return uploads from upload |
X |
||
|
Exclude marketplace shipping information uploads from upload |
X |
||
|
Reset the upload counter for marketplace order cancellation uploads |
X |
||
|
Reset the upload counter for marketplace payment uploads |
X |
||
|
Reset the upload counter for marketplace return uploads |
X |
||
|
Reset the upload counter for marketplace shipping information uploads |
X |
||
|
Payment method |
Query payment methods |
X |
|
|
Printer |
Installed printers |
X |
|
|
Product groups command |
Add new product groups |
X |
|
|
Delete existing product groups |
X |
||
|
Update the properties of product groups |
X |
||
|
Production items query |
Retrieve a production item by its ID |
X |
|
|
Retrieve a production item by the ID of the underlying item |
X |
||
|
Production orders command |
Create a new production order |
X |
|
|
Release an existing production order |
X |
||
|
Production orders query |
Retrieve a production order by its ID |
X |
|
|
Property |
Create property group |
X |
|
|
Create property |
X |
||
|
Create property value description |
X |
||
|
Create property value |
X |
||
|
Delete property value |
X |
||
|
Delete property value description |
X |
||
|
Query properties |
X |
||
|
Query property groups |
X |
||
|
Query property value descriptions |
X |
||
|
Query property values |
X |
||
|
Update property value description |
X |
||
|
Update property value |
X |
||
|
Report |
Mark report completed |
X |
|
|
Report |
X |
||
|
Send data |
X |
||
|
Report |
X |
||
|
Request report |
X |
||
|
Return |
Return announcement |
X |
|
|
Return processing result |
X |
||
|
Create return |
X |
||
|
Get return |
X |
||
|
Query return line items |
X |
||
|
Query return packages |
X |
||
|
Query Return |
X |
||
|
Return reason |
Query return reasons |
X |
|
|
Return state |
Query return states |
X |
|
|
Sales channels command |
Update the active sales channels for a set of items |
X |
|
|
Sales invoice correction domain command |
Cancel a sales invoice correction |
X |
|
|
Create a new sales invoice correction from an existing invoice |
X |
||
|
Sales invoice domain command |
Cancel a sales invoice |
X |
|
|
Create a new sales invoice for a sales order |
X |
||
|
Sales order domain command |
Calculate prices, discounts and taxes for a sales order without persisting it |
X |
|
|
Create a new sales order |
X |
||
|
Modify an existing sales order |
X |
||
|
Sales order domain query |
Deliver a single sales order by its ID |
X |
|
|
Return a list of price details for the requested items |
X |
||
|
Return an empty sales order with default values without persisting it |
X |
||
|
Sales quotation domain command |
Cancel a sales quotation |
X |
|
|
Create a new sales order for a sales quotation |
X |
||
|
Create a new sales quotation |
X |
||
|
Sales quotation domain query |
Deliver a single sales quotation by its ID |
X |
|
|
Saleschannel |
Get sales channels |
X |
|
|
Sales order |
Cancel sales order |
X |
|
|
Create sales order file |
X |
||
|
Create sales order line item file |
X |
||
|
Create sales order line item |
X |
||
|
Create sales order note |
X |
||
|
Delete sales order custom field |
X |
||
|
Delete sales order file |
X |
||
|
Delete sales order line item |
X |
||
|
Delete sales order line item file |
X |
||
|
Delete sales order note |
X |
||
|
Mail sales order |
X |
||
|
PDF sales order |
X |
||
|
Print sales order |
X |
||
|
Query sales order file data |
X |
||
|
Query sales order files |
X |
||
|
Query sales order line item file data |
X |
||
|
Query sales order line item files |
X |
||
|
Query sales order line items |
X |
||
|
Query sales order notes |
X |
||
|
Query sales order workflow events |
X |
||
|
Trigger sales order workflow event |
X |
||
|
Trigger sales order workflow |
X |
||
|
Update sales order custom field |
X |
||
|
Update sales order file |
X |
||
|
Update sales order line item file |
X |
||
|
Update sales order line item |
X |
||
|
Update sales order note |
X |
||
|
Update sales order |
X |
||
|
Seller |
Create seller |
X |
|
|
Read the signup session |
X |
||
|
Read update session |
X |
||
|
Unlink seller |
X |
||
|
Update seller |
X |
||
|
Shipment |
Package weight |
X |
|
|
Shipping label |
X |
||
|
Shipment packages command |
Deliver an existing package |
X |
|
|
Modify an existing package weight |
X |
||
|
Shipment packages query |
Deliver order data for a specific package |
X |
|
|
Shipping class command |
Create a new shipping class |
X |
|
|
Shipping method |
Query shipping methods |
X |
|
|
Stock |
Query serial number per warehouse |
X |
|
|
Query stock changes |
X |
||
|
Query stocks per item |
X |
||
|
Stock adjustment |
X |
||
|
Stock updates |
Stock Update (all sellers) |
X |
|
|
Stock Update (by seller) |
X |
||
|
Supplier |
Query suppliers |
X |
|
|
Supported prices |
Price types |
X |
|
|
Tax |
Get tax for item |
X |
|
|
Get tax for tax class |
X |
||
|
Tax domain command |
Create a new tax class in the system |
X |
|
|
Create a new tax code in the system |
X |
||
|
Delete an existing tax class |
X |
||
|
Delete an existing tax code |
X |
||
|
Update an existing tax class |
X |
||
|
Update an existing tax code |
X |
||
|
Tax domain query |
Return a list of all tax classes and their calculated tax rates for the given parameters |
X |
|
|
Ticket |
Create ticket |
X |
|
|
Download attachment |
X |
||
|
Upload attachment |
X |
||
|
Download attachment |
X |
||
|
Reply to ticket |
X |
||
|
Upload attachment |
X |
||
|
Transaction status |
Query transaction status |
X |
|
|
Warehouse |
Query storage location type |
X |
|
|
Query storage locations |
X |
||
|
Query warehouse types |
X |
||
|
Query warehouses |
X |
||
|
Warehouse assistant command |
Create a new shipping box within a warehouse |
X |
|
|
Permanently delete a shipping box and all its attributes (rule SB 8) |
X |
||
|
Reassign a shipping box to a different bin location (rule SB 5) |
X |
||
|
Update mutable metadata of an existing shipping box |
X |
||
|
Warehouse zone command |
Add bin locations to a warehouse zone |
X |
|
|
Create a new warehouse zone |
X |
||
|
Delete a warehouse zone |
X |
||
|
Remove bin locations from a warehouse zone |
X |
||
|
Update mutable metadata (code description type) of an existing warehouse zone |
X |
||
|
WMS |
Create pick list |
X |
|
|
Query pick list |
X |
||
|
Query pick list position |
X |
||
|
Query pick list template |
X |
||
|
Workbench resource types command |
Create a new workbench resource type |
X |
|
|
Workbench resource types query |
Query a single workbench resource type by its ID |
X |
|
|
Workbench resources command |
Create a new workbench resource |
X |
|
|
Workbench resources query |
Retrieve a single workbench resource by its ID |
X |
|
|
Worker |
Configure sync |
X |
|
|
Get worker status |
X |
||
|
Get worker syncs |
X |
||
|
Sync control |
X |