Purpose

Requiredness: “Yes” is shown only where the source marks a field required. A blank source cell means requiredness is not stated here; it does not mean optional.

Prerequisites

Use this reference for the documented BigQuery mapping. Select the entity and direction you need to review; this guide does not confirm which flows are enabled for your account.

Steps

  1. Find the entity you want to review in the tables below.
  2. Check the documented direction and schedule for that entity.
  3. Compare the field name and description within that same entity's table, including its requiredness marking. Do not use a same-named field from another entity as its definition.
  4. For an outbound flow, use its separately named outbound table rather than the inbound field schema.

Fields and columns

Documented query setup

Use the fixed query names listed below for the documented data categories and tailored SQL queries. Fields marked as replication keys identify new or updated records for incremental synchronization.

The documented fixed query names are: Products, SalesOrders, SalesOrdersLines, Suppliers, SupplierProducts, BuyOrders, BuyOrdersLines, ItemDeliveries, and ProductCompositions.

Synchronisation schedule and direction

Your enabled flows or agreed schedule may differ from the documented schedule below.

EntitySync FROM -> TOFrequency (min)
ProductsBQ > OPevery 60 min
SupplierBQ > OPevery 60 min
Supplier ProductsBQ > OPevery 60 min
Sell OrdersBQ > OPevery 60 min
Buy OrdersBQ > OPevery 60 min
Receipt LinesBQ > OPevery 60 min
Product CompositionsBQ > OPevery 60 min

Mapped fields

Products

OptiplyBigQueyRequired
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"—

Suppliers

OptiplyBigQueyRequired
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 Products

For supplier-product links, input productId and supplierId are remote identifiers from the Products and Suppliers inputs. The mapping uses previously imported product and supplier records to resolve them to Optiply IDs. During this matching step, a row without both matches is excluded. Use the source remote identifiers, not Optiply's generated IDs.

OptiplyBigQueyRequired
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.—
productIdThe source remoteId used in the Products input; resolved to the matching Optiply product ID.yes
supplierIdThe source remoteId used in the Suppliers input; resolved to the matching Optiply supplier ID.yes
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 Orders

OptiplyBigQueyRequired
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 Lines

Use the source sales-order identifier to attach each line to its order and the source product identifier to match the previously imported product. The import groups lines into each new order's orderLines, containing quantity, subtotalValue and the matched Optiply productId. The line's source remoteId and sellOrderId are used for input and matching, not sent as additional fields inside that group. An order without matching lines is excluded.

OptiplyBigQueyRequired
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 Orders

Input supplierId identifies the supplier by its source remoteId. With the previously imported supplier records, the mapping resolves it to the Optiply supplier ID before sending the order.

OptiplyBigQueyRequired
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.id integer - this should only be filled for BuyOrders synced from Optiply to Bigquery.Yes
supplierIdlong - The remoteId used in Suppliers Table - ID of the supplierID that's related with this buyOrderYes

Buy Order Lines

Use the source order and product remote identifiers in input buyOrderId and productId. The mapping matches them against previously imported orders and products, then sends the matching Optiply IDs. During each matching step, a line without the corresponding match is excluded.

OptiplyBigQueyRequired
remoteIdThe ID in the remote Systemyes
quantityintegeryes
productIdlong - The remoteId used in Products Table - ID of the product that's related with this sellOrderLineyes
buyOrderIdThe source remoteId used in the Buy Orders input; resolved to the matching Optiply buy-order ID.yes
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.lineid integer - this should only be filled for BuyOrders synced from Optiply to Bigquery.Yes

Receipt Lines

Input buyOrderLineId is the source remote identifier of the purchase-order line. With the previously imported purchase lines, the mapping resolves it to the Optiply line ID; a receipt without a match is excluded during that step. If the input has no occurred column, the import uses its current UTC processing time for that date. A supplied but empty date is not the same as an absent column.

OptiplyBigQueyRequired
remoteIdThe ID in the remote Systemyes
quantityintegeryes
buyOrderLineIdSource purchase-line remote identifier; resolved to the matching Optiply buy-order-line ID.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.id integer - this should only be filled for ReceiptLines synced from Optiply to Bigquery.yes

Product Compositions

Input composedProductId and partProductId identify the parent and component by their source product remote IDs. With the previously imported products, the mapping resolves both to Optiply product IDs. A composition without both product matches is excluded during that matching step.

OptiplyBigQueyRequired
remoteIdThe ID in the remote Systemyes
composedProductIdSource remoteId of the parent product; resolved to its Optiply product ID.yes
partProductIdSource remoteId of the component product; resolved to its Optiply product ID.yes
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"—

Outbound mappings documented by the source

These separately named tables describe outbound flows. The documented setup creates a destination table for each listed flow.

Buy Orders from Optiply to Bigquery

OptiplyBigQuey
buyOrder.idid
buyOrder.placedplaced
buyOrder.expectedDeliveryDatedelivery_date
supplier.remoteIdsupplier_remoteId
supplier.namesupplier_name
buyOrderLinesline_items (JSON with the line attributes)

Nested fields in line_items

The following documented fields belong inside the line_items JSON group, not at the top level of BuyOrders.

OptiplyBigQuey field inside line_items
buyOrderLine.idline_id
products.remoteIdproduct_remoteId
products.skuCodeproduct_sku
buyOrderLine.quantityquantity

Outbound requiredness is not specified for these mapping tables.

Receipt Lines from Optiply to Bigquery

OptiplyBigQuey
receiptLines.idid
receiptLines.occurredoccurred
receiptLines.buyOrderLineIdbuyOrderLineId
products.remoteIdproduct_remoteId
products.skuCodeproduct_sku
receiptLines.quantityquantity

Expected result

You can identify the documented field description, requiredness marking and direction for the selected entity. Reading this reference does not configure a connection or confirm a successful synchronization.

Limitations

This is a documented mapping reference, not confirmation of your enabled flows, current execution or synchronization result. Supplier-product matching needs the previously imported product and supplier records described above. Only the listed mappings are covered; do not infer additional nested fields or use a blank requiredness cell as an optional-field guarantee.

Errors and recovery

If your mapping differs from this reference, do not infer an alternative expression or retry procedure from a similarly named field. This guide does not provide a connection-recovery procedure or a tenant-specific mapping verdict.