Documented CSV file names
The source lists these file names for the data categories: Products, SalesOrders, SalesOrdersLines, Suppliers, SupplierProducts, BuyOrders, BuyOrdersLines, ItemDeliveries, and ProductCompositions. The source calls these fixed CSV names. This reference does not verify the names or flows configured for an account.
Incremental data synchronization
The source describes two approaches: a replication-key column in each CSV (with examples updated_at, timeStamp, or modified_at) to identify new or updated records, or delta files containing records created or modified since the prior transfer. It says that, with delta files, a replication key in the file is not needed and rows in the newly provided CSV are processed as updates. This is the source's documented description, not confirmation of an account's configuration.
Synchronization direction and frequency
| Entity | Direction | Documented frequency |
|---|---|---|
| Products | SFTP > OP | every 60 min |
| Supplier | SFTP > OP | every 60 min |
| Supplier Products | SFTP > OP | every 60 min |
| Sell Orders | SFTP > OP | every 60 min |
| Buy Orders | SFTP > OP | every 60 min |
| Receipt Lines | SFTP > OP | every 60 min |
| Product Compositions | SFTP > OP | every 60 min |
The source notes that frequency can be adjusted to customer needs.
Field table conventions
The first column is the Optiply field; the second preserves the source schema description. The Required values are copied as shown in the source: yes/Yes indicates a source-marked required row; a blank source cell remains blank. The tables are schema references, not confirmation that a file or mapping is configured.
Mapped fields
Product
| Optiply field | SFTP Products Table | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
name | string max length 255 | yes |
skuCode | string max length 255 - The SKU (Stock Keeping Unit) code that your own company uses | — |
articleCode | string max length 255 - An article code that your own company uses that is not the SKU or the EAN | — |
price | decimal max 9 integer digits, will round decimals to 2 places | — |
unlimitedStock | boolean - By setting this boolean to TRUE, stock tracking can be disabled. Set this to FALSE for products you want to buy. | yes |
stockLevel | integer, can be negative - The current physical level of stock minus already sold quantity. This calculation needs to be done in the Source system. Often called freeStock in other systems. | yes |
status | enum - enabled or disabled | — |
eanCode | Barcode - The EAN code used for selling this Product | — |
notBeingBought | boolean - When TRUE, Stock level advice for this product will be 0. Product will effectively not be bought | — |
created_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"(to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
Supplier
| Optiply field | SFTP Suppliers Table | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
name | string max length 255 | yes |
emails | string[] - (exemples: ["example@example.com"] or ["example@example.com";"example2@example.com"] | — |
deliveryTime | integer | — |
created_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
Supplier product
| Optiply field | SFTP Supplier Products Table | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
name | string max length 255 | yes |
skuCode | string max length 255 | — |
eanCode | string max length 255 | — |
articleCode | string max length 255 | — |
price | decimal max 9 integer digits, will round decimals to 2 places | — |
minimumPurchaseQuantity | integer - The minimum quantity that you will purchase of this product if you purchase it. This is 1 by default and is only allowed to be greater than or equal to 1. | — |
lotSize | integer - The lot size used when buying this product. E.g. when products are sold in sixpacks, the lotSize is 6. This is 1 by default and is only allowed to be greater than or equal to 1. | — |
productId | long - The remoteId used in Products Table | yes |
supplierId | long | yes |
preferred | boolean - Indicates this is a preferred supplier - can you be set one per Product | — |
status | enum - enabled or disabled. Use to mimic deletes. | — |
deliveryTime | integer - Supplier lead time per supplier product (days) | — |
created_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
Sell order
| Optiply field | SFTP Sell Orders Table | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
placed | datetime with time zone - date on which the order was placed and is to be sent | yes |
totalValue | decimal max 17 integer digits, will round decimals to 2 places | yes |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
Sell order line
| Optiply field | SFTP Sell Order Lines Table | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
quantity | integer | yes |
productId | long - The remoteId used in Products Table - ID of the product that's related with this sellOrderLine | yes |
sellOrderId | long - The remoteId used in Sell Order Table - ID of the sellOrder that this sellOrderLine is part of | yes |
subtotalValue | decimal max 17 integer digits, will round decimals to 2 places | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
Buy order
| Optiply field | SFTP Buy Orders Table | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
completed | datetime with time zone - Used to close the order. Fill when no products are left to be received. | — |
placed | datetime with time zone - This field denotes the date and the time BuyOrder is placed. | yes |
totalValue | decimal max 17 integer digits, will round decimals to 2 places | yes |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
reference | BuyOrders.idinteger - this should only be filled for BuyOrders synced from Optiply to SFTP. | Yes |
supplierId | long - The remoteId used in Suppliers Table - ID of the supplierID that's related with this buyOrder | Yes |
Buy order line
| Optiply field | SFTP Buy Order Lines | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
quantity | integer | yes |
productId | long - The remoteId used in Products Table - ID of the product that's related with this sellOrderLine | yes |
BuyOrderId | long - The remoteId used in Buy Order Table - ID of the BuyOrder that this BuyOrderLine belongs to | yes |
subtotalValue | decimal max 17 integer digits, will round decimals to 2 places | yes |
created_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
reference | BuyOrders.lineitems.lineidinteger - this should only be filled for BuyOrders synced from Optiply to SFTP. | Yes |
Receipt line
| Optiply field | SFTP Receipt Lines | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
quantity | integer | yes |
buyOrderLineId | integer - ID of the BuyOrderLine that owns this ReceiptLine. | yes |
occurred | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
reference | ReceiptLines.idinteger - this should only be filled for ReceiptLines synced from Optiply to SFTP. | yes |
Product composition
| Optiply field | SFTP Product Compositions | Required |
|---|---|---|
remoteId | The ID in the remote System | yes |
composedProductId | long | yes |
partProductId | long | yes |
partQuantity | integer - Must be at least 1. | yes |
created_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
updated_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key) | yes |
deleted_at | datetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" | — |
Each CSV must contain data matching the Optiply schema according to the source. The source labels reference fields as applying only to records synced from Optiply to SFTP; keep those direction qualifiers when reviewing the tables.
Purpose
Use this read-only task to compare a proposed SFTP CSV schema and schedule with the source reference without editing or transferring files.
Prerequisites
Have the proposed CSV category, field headers, requiredness markers, and intended incremental-sync approach available. The source does not confirm account-specific files or flows.
Steps
- Identify the documented category and match one of the nine fixed names:
Products,SalesOrders,SalesOrdersLines,Suppliers,SupplierProducts,BuyOrders,BuyOrdersLines,ItemDeliveries, orProductCompositions. - Select its entity table and compare field names/descriptions literally; do not infer undocumented columns.
- Read
yes/Yesas source-marked requiredness; blank Required cells are unstated, not optional. - Preserve
minimumPurchaseQuantityandlotSizedefaults as defaults, not requiredness markers. - Distinguish replication-key incremental sync from delta-file delivery; source says delta rows are processed as updates and need no replication key.
- Retain direction qualifiers on
referencefields and the seven schedule rows with the frequency-adjustment qualifier. - Record schema/schedule differences without editing or transferring files; this reference does not confirm configured files or flows.
Fields
The nine tables contain 79 source field rows, including Suppliers (7) and Supplier Products (16).
- Compare
remoteIdand explicit Required markers in the entity tables. - Compare
minimumPurchaseQuantity,lotSize, andBuyOrderIdexactly.
Expected result
A read-only comparison notes the CSV category, field/requiredness discrepancies, and replication-key or delta-file approach; no file is changed or uploaded.
Limitations
The fixed names, schema, requiredness, defaults, and frequencies are documented reference only. Frequency may be adjusted; account configuration and successful transfers are not verified.
Errors and recovery
If a file category or field cannot be matched, stop and record the exact header and expected source table. If an incremental approach is unknown, do not infer it; clarify from an authorized configuration source before relying on a tenant-specific conclusion.