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

EntityDirectionDocumented frequency
ProductsSFTP > OPevery 60 min
SupplierSFTP > OPevery 60 min
Supplier ProductsSFTP > OPevery 60 min
Sell OrdersSFTP > OPevery 60 min
Buy OrdersSFTP > OPevery 60 min
Receipt LinesSFTP > OPevery 60 min
Product CompositionsSFTP > OPevery 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 fieldSFTP Products TableRequired
remoteIdThe ID in the remote Systemyes
namestring max length 255yes
skuCodestring max length 255 - The SKU (Stock Keeping Unit) code that your own company uses—
articleCodestring max length 255 - An article code that your own company uses that is not the SKU or the EAN—
pricedecimal max 9 integer digits, will round decimals to 2 places—
unlimitedStockboolean - By setting this boolean to TRUE, stock tracking can be disabled. Set this to FALSE for products you want to buy.yes
stockLevelinteger, 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
statusenum - enabled or disabled—
eanCodeBarcode - The EAN code used for selling this Product—
notBeingBoughtboolean - When TRUE, Stock level advice for this product will be 0. Product will effectively not be bought—
created_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"(to be used as Replication Key)yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—

Supplier

Optiply fieldSFTP Suppliers TableRequired
remoteIdThe ID in the remote Systemyes
namestring max length 255yes
emailsstring[] - (exemples: ["example@example.com"] or ["example@example.com";"example2@example.com"]—
deliveryTimeinteger—
created_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—

Supplier product

Optiply fieldSFTP Supplier Products TableRequired
remoteIdThe ID in the remote Systemyes
namestring max length 255yes
skuCodestring max length 255—
eanCodestring max length 255—
articleCodestring max length 255—
pricedecimal max 9 integer digits, will round decimals to 2 places—
minimumPurchaseQuantityinteger - 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.—
lotSizeinteger - 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.—
productIdlong - The remoteId used in Products Tableyes
supplierIdlongyes
preferredboolean - Indicates this is a preferred supplier - can you be set one per Product—
statusenum - enabled or disabled. Use to mimic deletes.—
deliveryTimeinteger - Supplier lead time per supplier product (days)—
created_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—

Sell order

Optiply fieldSFTP Sell Orders TableRequired
remoteIdThe ID in the remote Systemyes
placeddatetime with time zone - date on which the order was placed and is to be sentyes
totalValuedecimal max 17 integer digits, will round decimals to 2 placesyes
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—

Sell order line

Optiply fieldSFTP Sell Order Lines TableRequired
remoteIdThe ID in the remote Systemyes
quantityintegeryes
productIdlong - The remoteId used in Products Table - ID of the product that's related with this sellOrderLineyes
sellOrderIdlong - The remoteId used in Sell Order Table - ID of the sellOrder that this sellOrderLine is part ofyes
subtotalValuedecimal max 17 integer digits, will round decimals to 2 placesyes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes

Buy order

Optiply fieldSFTP Buy Orders TableRequired
remoteIdThe ID in the remote Systemyes
completeddatetime with time zone - Used to close the order. Fill when no products are left to be received.—
placeddatetime with time zone - This field denotes the date and the time BuyOrder is placed.yes
totalValuedecimal max 17 integer digits, will round decimals to 2 placesyes
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
referenceBuyOrders.idinteger - this should only be filled for BuyOrders synced from Optiply to SFTP.Yes
supplierIdlong - The remoteId used in Suppliers Table - ID of the supplierID that's related with this buyOrderYes

Buy order line

Optiply fieldSFTP Buy Order LinesRequired
remoteIdThe ID in the remote Systemyes
quantityintegeryes
productIdlong - The remoteId used in Products Table - ID of the product that's related with this sellOrderLineyes
BuyOrderIdlong - The remoteId used in Buy Order Table - ID of the BuyOrder that this BuyOrderLine belongs toyes
subtotalValuedecimal max 17 integer digits, will round decimals to 2 placesyes
created_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
referenceBuyOrders.lineitems.lineidinteger - this should only be filled for BuyOrders synced from Optiply to SFTP.Yes

Receipt line

Optiply fieldSFTP Receipt LinesRequired
remoteIdThe ID in the remote Systemyes
quantityintegeryes
buyOrderLineIdinteger - ID of the BuyOrderLine that owns this ReceiptLine.yes
occurreddatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"yes
deleted_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
referenceReceiptLines.idinteger - this should only be filled for ReceiptLines synced from Optiply to SFTP.yes

Product composition

Optiply fieldSFTP Product CompositionsRequired
remoteIdThe ID in the remote Systemyes
composedProductIdlongyes
partProductIdlongyes
partQuantityinteger - Must be at least 1.yes
created_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ"—
updated_atdatetime with time zone, format "%Y-%m-%dT%H:%M:%SZ" (to be used as Replication Key)yes
deleted_atdatetime 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

  1. Identify the documented category and match one of the nine fixed names: Products, SalesOrders, SalesOrdersLines, Suppliers, SupplierProducts, BuyOrders, BuyOrdersLines, ItemDeliveries, or ProductCompositions.
  2. Select its entity table and compare field names/descriptions literally; do not infer undocumented columns.
  3. Read yes/Yes as source-marked requiredness; blank Required cells are unstated, not optional.
  4. Preserve minimumPurchaseQuantity and lotSize defaults as defaults, not requiredness markers.
  5. Distinguish replication-key incremental sync from delta-file delivery; source says delta rows are processed as updates and need no replication key.
  6. Retain direction qualifiers on reference fields and the seven schedule rows with the frequency-adjustment qualifier.
  7. 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 remoteId and explicit Required markers in the entity tables.
  • Compare minimumPurchaseQuantity, lotSize, and BuyOrderId exactly.

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.