1C-Bitrix client

What it does

The masstech.opotopo module uploads the catalog of a 1C-Bitrix online store to the platform: it creates and updates listings from products, SKU offers and stock, withdraws products that dropped out of the catalog, brings platform orders into site orders and fulfills them from the order form. No code is needed.

The module is built on the PHP client and is open source under the MIT license: code and releases — github.com/AdzerKI/seller-api-bitrix.

Installation

  1. Download the latest release archive and unpack it into the local/modules directory of the site.
  2. In the admin: "Marketplace" → "Installed solutions", "Install" for the "OPOTOPO Seller API" solution.

The module does not install without the "Information blocks", "Commercial catalog" and "e-Store" modules or on versions below the module requirements; the site encoding is UTF-8.

Settings

"Settings" → "Product settings" → "Module settings" → "OPOTOPO Seller API".

The "Platform" tab:

  • "Seller API key" — a key of the "API" section with the write listings, remove listings, file upload, read orders and fulfill orders permissions
  • "Organization ID" — the seller organization; without it products are created on behalf of the key organization, for a personal key — on behalf of its owner
  • "Publish listings immediately" — unchecked keeps new products as drafts
  • "Webhook endpoint secret" — the secret of the order receiving address
  • "Platform API URL" — the platform API address

The "Catalog" tab — the commercial catalog information block, the SKU, brand and gallery photo properties, the price type. The "Orders" tab — the site, payer type, buyer and payment system of platform orders; the inner account and payment systems that print receipts are not offered.

Catalog

Active elements of the catalog information block go to the platform — simple products and products with SKU offers:

  • SKU — the SKU property value, without it — bx- and the element ID
  • description — the detail text without markup, without it — the preview text
  • price — the price of the chosen type from the smallest quantity range, in another currency — in rubles at the "Currencies" module rate, for a product with offers — the lowest offer price
  • barcode — the first product barcode, brand — the brand property value, characteristics — properties shown in the product card
  • images — the detail or preview picture as the cover and the gallery photo property
  • weight and dimensions — of the catalog product, for a product with offers — the largest among offers
  • quantity — the available stock with quantity tracking or the sum of offer stock; without tracking — no quantity
  • variants — active offers with a price of the chosen type: the name is the offer property values shown in the card, the photo is the offer detail picture

Categories

The store category of a product is the path of its main section from the root. The platform category for it is chosen in the "Store categories" card of the "API" section: paths appear in the card with the first synchronization, a product of an unmapped category is rejected with its path, and the next synchronization after the choice creates it.

Synchronization

  • Changing or deleting a product or offer, a change of the chosen type price and of stock queue a synchronization with an agent; a full run goes every hour; runs never overlap
  • Agents are run by the site: on hits or by cron — with agents on cron the server scheduler has to run cron_events.php
  • The module settings show the last run summary, product rejections with details and the "Synchronize now" button; rejection codes — the PHP client

Orders

  1. The order receiving address is shown under the "Webhook endpoint secret" field. In the "Webhooks" block of the "API" section add this address with the "New order", "Purchase revoked" and "Order status changed" events, and put its signing secret into the "Webhook endpoint secret" field.
  2. A platform order becomes one site order paid with the chosen payment system and shipped from stock: lines are the catalog products of the listings, own delivery is priced as in the platform order, the recipient, phone, address and postal code are order properties, the platform order number, receiving method and pickup point go to the manager comment.
  • Received by the buyer — the order goes to the final status; cancelled — the shipment is undone with the stock restored, the payment is undone and the order is cancelled
  • A purchase revocation removes its line from the order with the stock restored, the payment follows the new order amount

Order fulfillment

The "OPOTOPO" block of the order view form shows the status and receiving method of the platform order and the actions its status allows:

  • "Hand over to delivery" — own delivery: the delivery service, tracking number and tracking address
  • "Ship with the carrier" — a drop-off point or "Carrier courier pickup" and places with weight in grams and dimensions in millimeters; without places every unit ships as its own place with the product package
  • "Ready for pickup" — pickup
  • "Cancel the order on OPOTOPO" — with a reason
  • "Label" and "Waybill" — shipment documents

The block is shown to users with the "Manage orders" right of the "e-Store" module. A platform refusal is shown in the block with its text.

Removal

"Marketplace" → "Installed solutions", "Delete" for the solution: the "Save tables" checkbox keeps the module tables and settings for a reinstall, without it they are removed. The listings on the platform stay.

Was this article helpful?

Did not find the answer to your question?

Create a request