Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Home
Actions
Constants
Attributes
Customer stages
Date types
Order types
Model types
Payment terms
SKU category
SKU lot selection
Tag classes
Rest API V1
Getting started (Swagger)
Access Swagger
Find Base URL
Available endpoints
Try out endpoints
Getting started (Tech docs)
Prerequisites
Making requests
Full endpoint URL
Parameters
Include
Pagination
Tags
Authentication
Use-case examples
Accounting system integration
Webshop integration
Warehouse integration
Managing tags
Managing locations
Swagger API docs mirror
Activities
/activities
Admin
/admin/teams/{teamId}/delete-elements
/admin/teams/{teamId}
/admin/teams/{team}/request-supporter-access
/admin/teams
/admin/user-logs
/admin/users/{userId}
/admin/users
Aggregator
/aggregator
B2B commerce
/b2b/categories/{categoryId}
/b2b/categories
/b2b/content/{contentId}
/b2b/content
/b2b/journey/{journeyId}
/b2b/journey
/b2b/menu/{menuId}
/b2b/menu
/b2b/products/{productId}
/b2b/products
/b2b/settings
/b2b/translations/{translationId}
/b2b/translations
/b2b/users/{userId}
/b2b/users
B2B Sales
/{partnerId}/sales/{orderId}/send
/{partnerId}/sales/{orderId}
B2bCategories
/b2b/categories/{b2bCategoryId}/image
/b2b/categories/{b2bContentId}/image
/categories/{b2bCategoryId}/image
B2bContents
/b2b/contents/{b2bContentId}/image
Canvas
/canvas/roles/{canvasRoleName}/disable
/canvas/roles/{canvasRoleName}/enable
/canvas/roles/{canvasRoleName}
/canvas/roles
/canvas/steps/{canvasStepName}
/canvas/steps
/canvas/tasks/{canvasTaskId}/move
/canvas/tasks/{canvasTaskId}
/canvas/tasks
Certificate Documents
/partners/{partnerId}/certificates/{certificateId}/document
Connection Entities
/connection-entities
/triggers
Connections
/connection-entities/{connectionEntityId}
/connection-entities
/connection/{connectionId}/upload-file
/connections/{connectionId}
/connections
Contract Documents
/contracts/{scope}/{contractId}/document
Contracts
/contract-import/{scope}
/contracts/{scope}/{contractId}
/contracts/{scope}
Cost Price Adjustments
/cost-price-adjustments/{costPriceAdjustmentId}/import
/cost-price-adjustments/{costPriceAdjustmentId}/skus/{skuId}
/cost-price-adjustments/{costPriceAdjustmentId}/skus
/cost-price-adjustments/{costPriceAdjustmentId}
/cost-price-adjustments
Countries
/countries/{countryCode}/states/{stateCode}
/countries/{countryCode}
/countries/{country_code}/states
/countries
Customer Contacts
/{partnerId}/contacts/{contactId}/default-contact
/{partnerId}/contacts/{contactId}
/{partnerId}/contacts
Customer Files
/{partnerId}/files
Customer Locations
/{partnerId}/locations/{locationId}/default-contact
/{partnerId}/locations/{locationId}
/{partnerId}/locations
Customer Partners
/{partnerId}/partners/{PartnerId}
Customer Products
/{partnerId}/products/{ProductId}
/{partnerId}/products
Customer sales
/{partnerId}/sales/{orderId}/document
/{partnerId}/sales/{orderId}/invoices/{invoiceId}/document
/{partnerId}/sales/{orderId}/sku/{skuId}
/{partnerId}/sales/{orderId}/sku
/{partnerId}/sales/{orderId}/skus
/{partnerId}/sales/{orderId}
/{partnerId}/sales
Dashboards
/dashboard-filters/{filtersId}
/dashboard-filters
/dashboard-iframes/{iframeId}
/dashboard-iframes
/dashboard-panel-tabs/{tabId}
/dashboard-panel-tabs
/dashboard-panels/{panelsId}
/dashboard-panels
/dashboards/{dashboardId}
/dashboards
Deliveries
/deliveries/{deliveryId}/add-lots
/deliveries/{deliveryId}/lines-extract
/deliveries/{deliveryId}/status
/deliveries/{deliveryId}
/deliveries
/delivery-ssccs/{deliveryLotSsccId}
/delivery-ssccs
/orders/{orderType}/{orderId}/inbound/deliveries
/orders/{orderType}/{orderId}/outbound/deliveries
Delivery Documents
/deliveries/{deliveryId}/documents
/deliveries/{deliveryId}/gs1-pallet-label-warnings
/deliveries/{deliveryId}/pallet-labels
Delivery Lots
/delivery-lots
/delivery/{deliveryId}/lots/{deliveryLotId}/sscc/{deliveryLotSsccId}
/delivery/{deliveryId}/lots/{deliveryLotId}/sscc
/delivery/{deliveryId}/lots/{lotId}
/delivery/{deliveryId}/lots
Delivery
/deliveries/{deliveryId}/lots
Document B2bTranslations
/b2b/translations
Document Strings
/document-strings/{documentStringId}
/document-strings
Document Templates
/document-template-settings/variable-by-name/{variableName}
/document-template-settings/variables/{documentVariableId}
/document-template-settings/variables
/document-template-settings
/label-settings
Document Translation
/document-template-settings/translations
Document Translations
/document-template-settings/translations
Document Variables
/document-template-settings/variables
Documents
/document-edi-integrations
/documents/{documentId}/send-with-edi/{integrationId}
/documents/{documentId}
/documents
/expense-pull-integrations/{integrationId}
/scanner-pull-integrations/{integrationId}
DocumentTranslation Templates
/document-template-settings/translations/{documentTranslationId}
Entity Numbers
/entity-numbers
EntityNumbers
/entity-numbers
Exchange Rates
/exchange-rates/{currencyCode}
/exchange-rates
Expense Lines
/expense/{expenseId}/lines/{expenseId}
/expense/{expenseId}/lines/{lineId}
/expense/{expenseId}/lines
Expense Metrics
/expenses/{expenseId}/metrics
Expenses
/expense-pull-integrations
/expenses/{expenseId}/lines
/expenses/{expenseId}/lots-affected
/expenses/{expenseId}/next-open-id
/expenses/{expenseId}/status
/expenses/{expenseId}
/expenses
Extracts
/exctract-data/{machine_name}/{format}
/extract-fields/{extractFieldId}
/extract-joins/{extractJoinId}
/extracts/{extractId}/available-fields
/extracts/{extractId}/dda
/extracts/{extractId}/fields/{extractFieldId}
/extracts/{extractId}/fields
/extracts/{extractId}/joins/{extractJoinId}
/extracts/{extractId}/joins
/extracts/{extractId}/preview
/extracts/{extractId}
/extracts
Files
/file-upload/{modelName}/{entityId}/single
/file-upload/{modelName}/{entityId}
/files/{fileId}/disable-role-access
/files/{fileId}/download
/files/{fileId}/enable-role-access
/files/{fileId}/favorite/{modelName}/{entityId}/{status}
/files/{fileId}
/files
FoodTalk
/foodtalk/discussions
Forecasting
/forecast-scenarios/{forecastScenarioId}
/forecast-scenarios
/forecasting/demand/{skuId}/{forecastScenarioId}/{periodKey}
/forecasting/demand
/forecasting/supply/{skuId}/{forecastScenarioId}/{periodKey}
/forecasting/supply
General Ledger
/gl-accounts/{glAccountId}/rules
/gl-accounts/{glAccountId}
/gl-accounts
GL Journals
/gl-journal-push-integrations
GLS
/gls-parcel-shops/{shopNumber}
/gls-parcel-shops
Import to API
/import-to-api/{templateType}/{templateId}/{importId}/start
/import-to-api/{templateType}/{templateId}/{importId}
/import-to-api/{templateType}/{templateId}
/import-to-api/{templateType}
Ingredients
/ingredients/import
/ingredients/{ingredientId}
/ingredients
Integrations
/integration-extids/{integrationExtidId}
/integration-extids
/integration-logs/{integrationLogId}
/integration-logs
/integrations/ongoing/inventory-control/{warehouseLocationId}
/integrations/ongoingv2/inventory-control/{warehouseLocationId}
Inventory
/bulk-adjust-quantities
/fifo-adjust-quantity-on-sku/{partnerLocationId}/{skuId}
/inventory
/lots/{lotId}/adjust-quantity
/lots/{lotId}/transform
/movements/{orderLotId}
/movements
/remove-all-adjustments
Invoice
/invoice-pull-status-integrations/{integrationId}
Invoices
/invoice-pull-status-integrations
Lots
/bulk-adjust-quantities
/inventory-planning
/lot-attribute-value/import-on-lots
/lot-attribute-value/import
/lot-attribute-values/{lotAttributeValueId}
/lot-attribute-values
/lot-attributes/{attributeName}/values/{lotAttributeValueId}
/lot-attributes/{attributeName}/values
/lot-dates/{lotDateId}
/lot-set-dates
/lot-status-changes/{lotStatusChangeId}
/lot-status-changes
/lot-status
/lots/import
/lots/{lotId}/adjust-quantity
/lots/{lotId}/select-input
/lots/{lotId}/transform
/lots/{lotId}/transformations
/lots/{lotId}
/lots
/remove-all-adjustments
/stock-taking/with-traceability/import
/stock-taking/without-traceability/import
Members
/members/{userId}
/members
Messages
/messages/{messageId}/document-file
/messages/{messageId}/sent
/messages/{messageId}
/messages
My profile
/my-profile
Nutrition
/nutrition/databases/frida-food-dk/{number}
/nutrition/databases/frida-food-dk
/nutrition/suggestions/{sku}
Order Budgets
/order/{orderType}/{orderId}/budgets/{budgetId}
/order/{orderType}/{orderId}/budgets/{budgetSection}/{budgetId}
/order/{orderType}/{orderId}/budgets
Order Counts & Metrics
/order-metrics/{orderType}
/orders/{orderType}/{orderId}/counts
/orders/{orderType}/{orderId}/metrics
Order Documents
/orders/{orderType}/{orderId}/documents/order-confirmation
Order Inbounds
/orders/{orderType}/{orderId}/inbound/adjust-to-recived
/orders/{orderType}/{orderId}/inbound/deliveries
/orders/{orderType}/{orderId}/inbound/lots/{orderLotId}/quick
/orders/{orderType}/{orderId}/inbound/lots/{orderLotId}
/orders/{orderType}/{orderId}/inbound/lots
/orders/{orderType}/{orderId}/inbound/next-line-ref
/orders/{orderType}/{orderId}/inbound/receive-quantities
/orders/{orderType}/{orderId}/inbound
Order Invoice Metrics
/invoices/{invoiceId}/metrics
Order Invoices
/invoices/{invoiceId}/booked
/invoices/{invoiceId}/complete
/invoices/{invoiceId}/credit-note
/invoices/{invoiceId}/documents/invoice
/invoices/{invoiceId}/lines-extract
/invoices/{invoiceId}/pdf
/invoices/{invoiceId}/status
/invoices/{invoiceId}
/invoices
/orders/{orderType}/{orderId}/draft-invoice
Order Links
/order-links/{orderLinkId}
/order-links
Order Outbounds
/orders/{orderType}/{orderId}/outbound/auto-suggest-inbound
/orders/{orderType}/{orderId}/outbound/create-inbound
/orders/{orderType}/{orderId}/outbound/delete-buffer-lines
/orders/{orderType}/{orderId}/outbound/deliveries
/orders/{orderType}/{orderId}/outbound/lots/{orderLotId}/picking-status
/orders/{orderType}/{orderId}/outbound/lots/{orderLotId}
/orders/{orderType}/{orderId}/outbound/lots
/orders/{orderType}/{orderId}/outbound/pick-and-dispatch
/orders/{orderType}/{orderId}/outbound/remove-lot-selections
/orders/{orderType}/{orderId}/outbound/select-lots
/orders/{orderType}/{orderId}/outbound/skus/{skuId}
/orders/{orderType}/{orderId}/outbound/skus
/orders/{orderType}/{orderId}/outbound/suggest-lots
/orders/{orderType}/{orderId}/outbound
/orders/{orderType}/{orderId}/service-lines
Order Parcels
/orders/{orderType}/{orderId}/parcels/{parcelId}
/orders/{orderType}/{orderId}/parcels/{parcelSection}/{parcelId}
/orders/{orderType}/{orderId}/parcels
Order Re-tracing
/orders/{orderType}/{orderId}/retrace
Order Service Lines
/orders/{orderType}/{orderId}/lookup-price-correction-prices/{skuId}
/orders/{orderType}/{orderId}/price-corrections/{serviceLineId}
/orders/{orderType}/{orderId}/price-corrections
/orders/{orderType}/{orderId}/service-lines/{serviceLineId}
/orders/{orderType}/{orderId}/service-lines
Orders
/deliveries/{deliveryId}/document-quick-access
/order-cancel-integrations/{orderType}/{integrationId}
/order-mirrors/{myOrderId}
/order-pull-integrations/{orderType}/{integrationId}
/order-pull-integrations/{orderType}
/order-search
/order/{orderType}/{orderId}/attach-document-as-file
/order/{orderType}/{orderId}/recalculate-service-lines
/orders/sales/{orderId}/return-order
/orders/sales
/orders/{orderType}/{orderId}/document-quick-access
/orders/{orderType}/{orderId}/preview-lot-lines
/orders/{orderType}/{orderId}/receive
/orders/{orderType}/{orderId}/time
/orders/{orderType}/{orderId}/{orderAction}
/orders/{orderType}/{orderId}
/orders/{orderType}
Partner Certificates
/certificates/{certificateId}
/certificates
/certification-schemes/{schemeId}
/certification-schemes
/partners/{partnerId}/certificates/{certificateId}
/partners/{partnerId}/certificates/{partnerCertificateId}/attach-document-as-file
/partners/{partnerId}/certificates
Partner Comments
/orders/{orderType}/{orderId}/partner-comments
/partners/{partnerId}/comments/{commentId}
/partners/{partnerId}/comments
Partner Contacts
/contacts/{contactId}
/contacts
/partners/{partnerId}/contacts/{contactId}
/partners/{partnerId}/contacts
Partner Invitations
/partners/{partnerId}/invite
Partner Locations
/location-by-number/{locationNumber}
/locations/{locationId}/default-contact
/locations/{locationId}/order-info
/locations/{locationId}
/locations
/partners/{partnerId}/locations/{locationId}
/partners/{partnerId}/locations
Partner Payment Methods
/partners/{partnerId}/payment-methods/{paymentMethodId}
/partners/{partnerId}/payment-methods
/payment-methods/{paymentMethodId}
/payment-methods
Partners
/partners/{partnerId}/action
/partners/{partnerId}/default-location
/partners/{partnerId}/logo
/partners/{partnerId}/metrics
/partners/{partnerId}
/partners
Price Lists
/discounts/{scope}/{discountId}
/discounts/{scope}/{priceId}
/discounts/{scope}
/price-lists/{scope}/{priceListId}/prices/{skuId}
/price-lists/{scope}/{priceListId}/prices
/price-lists/{scope}/{priceListId}
/price-lists/{scope}
/prices/{scope}/import
/prices/{scope}/{priceId}
/prices/{scope}
/skus/{skuId}/discount/{scope}
/skus/{skuId}/price/{scope}
Quantity Declarations
/quantity-declarations/{quantityDeclarationId}
/quantity-declarations
Recipes
/orders/production/{orderId}/outbound/refresh-raw-materials
/orders/production/{orderId}/recipes/{orderRecipeId}
/orders/production/{orderId}/recipes
/recipes/{recipeId}/budgets/{budgetId}
/recipes/{recipeId}/budgets
/recipes/{recipeId}/consumes/{consumeId}
/recipes/{recipeId}/consumes
/recipes/{recipeId}/produces/{produceId}
/recipes/{recipeId}/produces
/recipes/{recipeId}/steps/{stepId}
/recipes/{recipeId}/steps
/recipes/{recipeId}
/recipes
Report Presets
/report-presets/{reportName}/{reportPresetId}
/report-presets/{reportName}
ScannerRecords
/scanner-pull-integrations
Scanners & Scales
/scanner-record-bulk-action
/scanner-records/{scannerRecordId}
/scanners
Scanners
/scanner-pull-integrations}/{integrationId}
/scanners/{scannerId}/{scannerId}
/scanners/{scannerId}
Schedulers
/scheduler-commands
/scheduler/{schedulerId}/request-run
/scheduler/{schedulerId}
/scheduler
Services
/auto-order-line-import/{scope}
/auto-service-lines/{autoServiceLineId}/rules
/auto-service-lines/{autoServiceLineId}
/auto-service-lines
/service-import/{scope}
/services/{serviceId}
/services
Sku Comments
/skus/{skuId}/comments/{commentId}
/skus/{skuId}/comments
Skus
/push-catalog-integrations/{integrationId}
/push-catalog-integrations
/skus/{skuId}/quantity-declarations
Stock Keeping Units
/partners/import
/quantity-declarations/import
/recipes/import
/sku/document-edi-load
/sku/import
/skus-suggest-sku-code
/skus/{skuId}/availability
/skus/{skuId}/pim
/skus/{skuId}/subs
/skus/{skuId}/with-attribute-options
/skus/{skuId}
/skus
Tags
/tag-attach/{modelName}/{entityId}
/tag-by-name/{modelName}
/tag-detach/{modelName}/{entityId}
/tags/import
/tags/{tagId}
/tags
Tasks & Controls
/tasks-and-controls/controls/{controlId}
/tasks-and-controls/controls
/tasks-and-controls/my-pending-tasks-count
/tasks-and-controls/occurrences/{taskOccurrenceId}/files/{controlId}
/tasks-and-controls/occurrences/{taskOccurrenceId}/restore
/tasks-and-controls/occurrences/{taskOccurrenceId}/trash
/tasks-and-controls/occurrences/{taskOccurrenceId}
/tasks-and-controls/occurrences
/tasks-and-controls/resources/{resourceId}
/tasks-and-controls/resources
/tasks-and-controls/sync-with-rules
/tasks-and-controls/tasks/{taskId}
/tasks-and-controls/tasks
Traces
/auto-traces/{extractId}/available-fields
/auto-traces/{extractId}/dda
/auto-traces/{extractId}/preview
/auto-traces/{extractId}
/auto-traces
/los-traces/{traceId}
/traces/{traceId}
/traces
Tracker Records
/tracker-record-by-ref/{trackerRef}/{recordRef}
/tracker-records/{trackerRecordId}
/tracker-records
Triggers
/triggers/{triggerId}/my-subscription/{channel}
/triggers/{triggerId}/run/{entityId}
/triggers/{triggerId}
/triggers
Vats
/vats/{vatId}/rules
/vats/{vatId}
/vats
Connect
Connections
Triggers
Inbox
Outbox
Subscriptions
Connect REST API
Connect SFTP
Printing
Shipmondo
XML parsing
Liquid
Variables
Filters
add_query_param_to_url
app_url
append_fnc1
append_newline
arr_get
array_range
b2b_var
base64_encode
collection_get
collection_put
confirm_forecast_scenario_action_url
confirm_order_action_url
confirm_partner_action_url
connection_get_request
connection_send_custom_document_url
country_in_region
country_name
data_bucket_set
data_table
date_add_days
date_add_months
date_add_years
date_days_ago
date_end_of_month
date_end_of_week
date_format_document
date_format_gs1_ai
date_format_short
date_from_tsms
date_from_xlsx
date_months_ago
date_start_of_month
date_start_of_week
day_name
doc_string
doc_string_key
dump_var
enterprise_client_sku_code_uom_from_order
enterprise_mirrored_all_client_sales_order_ids
enterprise_mirrored_client_order_ids_from_customer_orders
enterprise_mirrored_return_umbrella_order_id
enterprise_mirrored_sales_client_first_order_number
enterprise_mirrored_sales_client_order_number
enterprise_mirrored_sales_delivery_number
enterprise_order_is_mirrored
entity_image_preview_src
entity_image_src
equals
escape_csv
escape_xml
expiry_date
extract_data
extract_dda_url
extract_from_machine_name
extract_id_from_machine_name
faker_inventory
file_get_info
file_get_raw
filter_date_value
filter_value
first
format_address
has_tag
has_tag_code
in_args
invoice_quantity_declaration_sum
is_empty
is_equal_to
is_valid_email
keep_alphanumeric
keep_numbers
keep_numeric
list_filter
list_filter_from_master_sku_id
list_find
list_length
list_pluck
list_range
list_sort_place_last
list_unique
list_unique_master_sku_ids
lookup_latest_price_list_discount_before
lookup_latest_price_list_price_before
lookup_order_lot_url
lookup_order_price
lookup_price_list_discount
lookup_price_list_price
lot_attribute_value
lot_date
lot_status_is_before_receipt
min
modulus_10_check_digit
month_name
my_partner_var
my_start_page
number_format
ongoing_expiry_date
ongoing_get
order_delivery_number
order_document_url
order_id_from_delivery_number
order_invoice_to_location
order_invoice_to_partner
order_line_refs
order_page_url
order_prefixed_number
order_quantities
order_quantity_declaration_sum
order_shipping_label_url
order_status_confirmable
order_status_deliverable
order_status_dispatchable
order_status_pickable
order_status_reopenable
parse_country
parse_csv
parse_incoterm
parse_url
partner_id_from_creditor_no
partner_id_from_debtor_no
partner_id_from_location_id
partner_id_from_location_ref
partner_id_from_name
partner_id_from_ref
partner_id_from_sku_code
partner_id_from_sku_id
partner_location_id_from_gln
partner_location_id_from_ref
partner_ref_from_id
payment_method_from_partner
payment_method_from_ref
price_list_ref_from_order_id
qr_code_image
recipient_name
region_country_list
seq_next
set_doc_lang
sku_allergens
sku_default_attribute_value
sku_exists_on_order
sku_has_tag
sku_id_from_ean
sku_id_from_partner_sku_code
sku_id_from_sku_code
sku_id_from_sku_code_auto_create
sku_ids_from_partner_id
sku_image_preview_src
sku_image_src
sku_my_partner_value
sku_partner_code_from_ean
sku_partner_value
sku_tag_exists_on_order
sort_by_path
sscc_check_digit
string_contains
string_part
string_random
strip
sub_sku_quantity
suggested_language
sum
sum_if
system_token
task_control_file_get_raw
task_occurrence_url
team_switch_to
team_var
template_entity_url
template_id_from_ref
template_id_with_tag
template_id_with_tag_or_ref
throw_error
timestamp_add_hours
timestamp_diff_in_seconds
top_priority_sub_sku_id
trace_pluck
transform_allergens
translate
translate_customer_stage
translate_lot_status
translate_order_status
translate_order_type
translate_unit
unit_convertible_with
url_query_string
user_setting
user_var
Use-case examples
Check if SKU has a tag
Schedulers
Accounting - Create And Send Collective Invoice For Customer
Accounting - Create And Send Invoices
Accounting - Create Case Orders From Invoice Items
Accounting - Create Invoice Items From Extracts
Accounting - Pull Expenses From Accounting System
Confs - Swedish - Load Alcohol Taxes
Cost Prices - Run Pending Adjustments
Forecasting - Bulk Create Production Orders
Forecasting - Bulk Create Purchase Orders
Forecasting - Estimate Sales Forecast
Forecasting - Request Supply Estimate
Integration - Pull Order Updates
Integration - Pull Sales Orders
Integration - Pull Transporters
Integration - Push Catalog
Integration - Sync Inventory
Ongoing - Create Fake Logger Records
Ongoing - Sync Inventory For Sku
Ongoing - Sync Master Data For Team
Orders - Finish Sales Without Invoice
Orders - Move Pickup Date On Open Orders
Orders - Receive Finished Auto Inbound Purchases
Orders - Refresh Prices
Orders - Remove Adjustments
Orders - Select Lots For Orders
Orders - Tag Used Open Inbound Orders
Orders - Warehouse Transorm To Multi Inbounds
Partners - Anonymize Person Locations
Partners - Delete All
Perms - Remove All Perms For Role
Template editor
Basics
Document strings
Custom Template Model
Data Extract Model
PDF output
HTML output
Examples
Pallet label
Production overview
Print Shipmondo label
Reference code
Concepts
Data Extracts
Extract with Coalesce
Present data from multiple cubes
Joins
Join Recipies to Order
Understanding postgresql
Time Range
Custom Templates
Collect Data
Fomatting Dates
Measurement & Units
Contact us
tracezilla.com
Rest API V1
Swagger API docs mirror
Aggregator
This page was automatically generated from tracezilla’s
Swagger API documentation
2026-07-17
Aggregator
Table of contents
/aggregator