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
- Find the entity you want to review in the tables below.
- Check the documented direction and schedule for that entity.
- 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.
- 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.
| Entity | Sync FROM -> TO | Frequency (min) |
|---|---|---|
| Products | BQ > OP | every 60 min |
| Supplier | BQ > OP | every 60 min |
| Supplier Products | BQ > OP | every 60 min |
| Sell Orders | BQ > OP | every 60 min |
| Buy Orders | BQ > OP | every 60 min |
| Receipt Lines | BQ > OP | every 60 min |
| Product Compositions | BQ > OP | every 60 min |
Mapped fields
Products
| Optiply | BigQuey | 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" | — |
Suppliers
| Optiply | BigQuey | 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 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.
| Optiply | BigQuey | 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 | The source remoteId used in the Products input; resolved to the matching Optiply product ID. | yes |
| supplierId | The source remoteId used in the Suppliers input; resolved to the matching Optiply supplier ID. | 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 Orders
| Optiply | BigQuey | 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 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.
| Optiply | BigQuey | 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 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.
| Optiply | BigQuey | 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.id integer - this should only be filled for BuyOrders synced from Optiply to Bigquery. | Yes |
| supplierId | long - The remoteId used in Suppliers Table - ID of the supplierID that's related with this buyOrder | Yes |
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.
| Optiply | BigQuey | 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 | The source remoteId used in the Buy Orders input; resolved to the matching Optiply buy-order ID. | 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.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.
| Optiply | BigQuey | Required |
|---|---|---|
| remoteId | The ID in the remote System | yes |
| quantity | integer | yes |
| buyOrderLineId | Source purchase-line remote identifier; resolved to the matching Optiply buy-order-line ID. | 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.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.
| Optiply | BigQuey | Required |
|---|---|---|
| remoteId | The ID in the remote System | yes |
| composedProductId | Source remoteId of the parent product; resolved to its Optiply product ID. | yes |
| partProductId | Source remoteId of the component product; resolved to its Optiply product ID. | 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" | — |
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
| Optiply | BigQuey |
|---|---|
| buyOrder.id | id |
| buyOrder.placed | placed |
| buyOrder.expectedDeliveryDate | delivery_date |
| supplier.remoteId | supplier_remoteId |
| supplier.name | supplier_name |
| buyOrderLines | line_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.
| Optiply | BigQuey field inside line_items |
|---|---|
| buyOrderLine.id | line_id |
| products.remoteId | product_remoteId |
| products.skuCode | product_sku |
| buyOrderLine.quantity | quantity |
Outbound requiredness is not specified for these mapping tables.
Receipt Lines from Optiply to Bigquery
| Optiply | BigQuey |
|---|---|
| receiptLines.id | id |
| receiptLines.occurred | occurred |
| receiptLines.buyOrderLineId | buyOrderLineId |
| products.remoteId | product_remoteId |
| products.skuCode | product_sku |
| receiptLines.quantity | quantity |
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.