Optiply

https://help.optiply.com/en
Admin
Optiply is an inventory optimization and forecasting platform that connects to e-commerce and WMS...
Tokens:88,325
Snippets:1,728
Trust Score:7.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /seller/suppliers

Source: https://help.optiply.com/en/articles/13630346-channeldock-data-mapping-synchronisation

Retrieves supplier data from ChannelDock.

```APIDOC
## GET /seller/suppliers

### Description
Retrieves a list of suppliers from ChannelDock.

### Method
GET

### Endpoint
/seller/suppliers
```

--------------------------------

### Buy Order Lines (/api/v1/purchaseorders.products)

Source: https://help.optiply.com/en/articles/3765225-picqer-data-mapping-synchronisation

Mapping documentation for purchase order lines between Optiply and Picqer.

```APIDOC
## Buy Order Lines (/api/v1/purchaseorders.products)

### Description
Maps purchase order line data from Picqer to Optiply.

### Parameters
- **Price** (purchaseorders.products.price) - If missing, falls back to products.price.
- **Quantity** (amount) - Required.
- **Subtotal Value** (Calculated) - Calculated as amount * price.
- **Expected Delivery** (delivery_date) - Uses the line delivery date if not null; otherwise parent delivery date.
```

--------------------------------

### GET /Vendor.json

Source: https://help.optiply.com/en/articles/13714849-lightspeed-r-series-data-mapping-synchronisation

Retrieves supplier data mapping.

```APIDOC
## GET /Vendor.json

### Description
Retrieves supplier data mapping.

### Method
GET

### Endpoint
/Vendor.json

### Response
- **name** (string) - Supplier Name
- **vendorId** (string) - Remote ID
```

--------------------------------

### Select Promotion Products for Synchronization

Source: https://help.optiply.com/en/articles/12495488-ms-sql-data-mapping-syncronisation

Use this SQL query to extract promotion product data based on a replication key for incremental synchronization.

```sql
SELECT yt.id as remote_id,

yt.productId as productId,

yt.promotionId as promotionId,

yt.specificUpliftType as specificUpliftType,

yt.specificUpliftIncrease as specificUpliftIncrease,

yt.updated_at as updated_at

FROM your_table yt

WHERE {replication_key_condition}

//replication_key_condition: {replication_key} >= {formatted_replication_key_value}
```

--------------------------------

### GET /seller/orders

Source: https://help.optiply.com/en/articles/13630346-channeldock-data-mapping-synchronisation

Retrieves sell order data from ChannelDock.

```APIDOC
## GET /seller/orders

### Description
Retrieves sell order information including totals and dates.

### Method
GET

### Endpoint
/seller/orders
```

--------------------------------

### Select Promotions for Synchronization

Source: https://help.optiply.com/en/articles/12495488-ms-sql-data-mapping-syncronisation

Use this query to map promotion data to Optiply. Note that startDate and endDate are processed on a per-day basis.

```sql
SELECT yt.id as remote_id,

yt.enabled as enabled,

yt.entireShop as entireShop,

yt.startDate as startDate,

yt.endDate as endDate,

yt.upliftType as upliftType,

yt.upliftIncrease as upliftIncrease,

yt.updated_at as updated_at

FROM your_table yt

WHERE {replication_key_condition}

//replication_key_condition: {replication_key} >= {formatted_replication_key_value}
```

--------------------------------

### GET /seller/delivery

Source: https://help.optiply.com/en/articles/13630346-channeldock-data-mapping-synchronisation

Retrieves buy order data from ChannelDock.

```APIDOC
## GET /seller/delivery?delivery_type=inbound

### Description
Retrieves buy order data from ChannelDock for synchronization with Optiply.

### Method
GET

### Endpoint
/seller/delivery?delivery_type=inbound

### Query Parameters
- **delivery_type** (string) - Required - Must be set to 'inbound'.
```

--------------------------------

### Map Product Data to Optiply Schema

Source: https://help.optiply.com/en/articles/9352512-bigquery-data-mapping-synchronisation

SQL query template for mapping source table columns to the required Optiply product fields, including a placeholder for replication key filtering.

```sql
SELECT yt.id as remote_id,

yt.big_name as name,

yt.sku as skuCode,

yt.Code as articleCode,

yt.price as price,

yt.managedStock as unlimitedStock,

yt.stock as stockLevel,

yt.status as status,

yt.EAN as eanCode,

yt.created_at as created_at,

yt.updated_at as updated_at,

yt.deleted as deleted_at

FROM your_table yt

WHERE {replication_key_condition}

*//replication_key_condition: {replication_key} >= {formatted_replication_key_value}*
```

--------------------------------

### GET /seller/inventory

Source: https://help.optiply.com/en/articles/13630346-channeldock-data-mapping-synchronisation

Retrieves inventory and product data associated with suppliers.

```APIDOC
## GET /seller/inventory

### Description
Retrieves supplier product inventory data.

### Method
GET

### Endpoint
/seller/inventory
```
Tokens:
Raw