{"openapi":"3.0.0","paths":{"/v1/me":{"get":{"operationId":"MeController_me","parameters":[],"responses":{"200":{"description":""}},"summary":"Connectivity test: identity, scopes and limits of this API key","tags":["Me"]}},"/v1/catalog/products":{"post":{"operationId":"CatalogController_products","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"dryRun","required":false,"in":"query","description":"true → validate only, write nothing","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductsBatchDto"}}}},"responses":{"202":{"description":"Accepted"}},"summary":"Bulk upsert products (≤1000). Returns 202 + batchId; processed asynchronously.","tags":["Catalog"]},"get":{"operationId":"CatalogController_list","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"updatedSince","required":false,"in":"query","schema":{"type":"string"}},{"name":"sourceId","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":false,"in":"query","schema":{}},{"name":"page","required":false,"in":"query","schema":{}}],"responses":{"200":{"description":""}},"summary":"Our view of your products: listing status, search index presence, image, code count","tags":["Catalog"]}},"/v1/catalog/stock":{"patch":{"operationId":"CatalogController_stock","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"dryRun","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockBatchDto"}}}},"responses":{"202":{"description":""}},"summary":"Stock only (≤5000) — hot lane, live in < 30 s","tags":["Catalog"]}},"/v1/catalog/prices":{"patch":{"operationId":"CatalogController_prices","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"dryRun","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceBatchDto"}}}},"responses":{"202":{"description":""}},"summary":"Prices only (≤5000) — hot lane","tags":["Catalog"]}},"/v1/catalog/products/{sourceId}":{"delete":{"operationId":"CatalogController_deactivate","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"sourceId","required":true,"in":"path","schema":{"type":"string"}},{"name":"dryRun","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"202":{"description":""}},"summary":"Deactivate a listing (not deleted; removed from storefront)","tags":["Catalog"]}},"/v1/catalog/products/deactivate":{"post":{"operationId":"CatalogController_deactivateMany","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"dryRun","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"202":{"description":""}},"summary":"Bulk deactivate: {\"sourceIds\":[...]} (≤5000)","tags":["Catalog"]}},"/v1/catalog/imports":{"post":{"operationId":"CatalogController_createImport","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportCreateDto"}}}},"responses":{"201":{"description":""}},"summary":"Large catalog: obtain a presigned upload URL (NDJSON.gz, millions of rows)","tags":["Catalog"]}},"/v1/catalog/imports/{batchId}/complete":{"post":{"operationId":"CatalogController_completeImport","parameters":[{"name":"X-Api-Secret","in":"header","required":true,"schema":{"type":"string"}},{"name":"X-Api-Key","in":"header","required":true,"schema":{"type":"string"}},{"name":"batchId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"202":{"description":""}},"summary":"File uploaded → start processing","tags":["Catalog"]}},"/v1/catalog/batches":{"get":{"operationId":"BatchesController_list","parameters":[{"name":"kind","required":false,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":false,"in":"query","schema":{}},{"name":"page","required":false,"in":"query","schema":{}}],"responses":{"200":{"description":""}},"summary":"Recent batches","tags":["Batches"]}},"/v1/catalog/batches/{id}":{"get":{"operationId":"BatchesController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Batch status: phases, counts, durations","tags":["Batches"]}},"/v1/catalog/batches/{id}/errors":{"get":{"operationId":"BatchesController_errors","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"severity","required":false,"in":"query","schema":{"enum":["error","warning"],"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Row-level error/warning report (paged)","tags":["Batches"]}},"/v1/catalog/batches/{id}/errors.csv":{"get":{"operationId":"BatchesController_errorsCsv","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Error report as CSV (opens in Excel)","tags":["Batches"]}},"/v1/logs/requests":{"get":{"operationId":"LogsController_requests","parameters":[{"name":"since","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":false,"in":"query","schema":{}},{"name":"page","required":false,"in":"query","schema":{}}],"responses":{"200":{"description":""}},"summary":"Request log for the last 30 days (route, status, duration, requestId)","tags":["Logs"]}},"/v1/orders":{"get":{"operationId":"OrdersController_list","parameters":[{"name":"status","required":false,"in":"query","description":"new | preparing | problem | waiting_approval | waiting_payment | in_cargo | cancelled | completed","schema":{"type":"string"}},{"name":"updatedSince","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Orders of the seller (status, updatedSince, paging)","tags":["Orders"]}},"/v1/orders/carriers":{"get":{"operationId":"OrdersController_carriers","parameters":[],"responses":{"200":{"description":""}},"summary":"Available carriers","tags":["Orders"]}},"/v1/orders/{id}":{"get":{"operationId":"OrdersController_detail","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Order detail (items, invoices, shipments, returns)","tags":["Orders"]}},"/v1/orders/{id}/approve":{"post":{"operationId":"OrdersController_approve","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Approve the order","tags":["Orders"]}},"/v1/orders/{id}/status":{"post":{"operationId":"OrdersController_status","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Update order status: {\"status\": \"preparing\" | \"problem\" | \"cancelled\" | ...}","tags":["Orders"]}},"/v1/orders/{id}/shipments":{"post":{"operationId":"OrdersController_shipment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Register your own shipment: {cargoId?, trackNumber, trackUrl?, shipmentDate?}","tags":["Orders"]}},"/v1/orders/{id}/shipments/create":{"post":{"operationId":"OrdersController_createShipment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Create a shipment with a Bicops contracted carrier; {warehouse?}","tags":["Orders"]}},"/v1/orders/{id}/shipments/label":{"get":{"operationId":"OrdersController_label","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"warehouse","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Shipment label (PDF, base64)","tags":["Orders"]}},"/v1/orders/{id}/erp-reference":{"post":{"operationId":"OrdersController_erpRef","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Store your ERP reference for the order: {reference, meta?}","tags":["Orders"]}},"/v1/orders/{id}/messages":{"get":{"operationId":"OrdersController_messages","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Order messages","tags":["Orders"]}},"/v1/orders/{id}/documents":{"get":{"operationId":"OrdersController_documents","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Order documents (order form, delivery note)","tags":["Orders"]}},"/v1/returns":{"get":{"operationId":"ReturnsController_list","parameters":[{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"updatedSince","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Return requests (status, updatedSince)","tags":["Returns"]}},"/v1/returns/{id}":{"get":{"operationId":"ReturnsController_get","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Returns"]}},"/v1/returns/{id}/decision":{"post":{"operationId":"ReturnsController_decide","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Decide on a return: {action: 'approve'|'reject', notes?, returnCargoId?, returnDate?}","tags":["Returns"]}},"/v1/cancellations":{"get":{"operationId":"ReturnsController_cancellations","parameters":[{"name":"since","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Cancelled orders","tags":["Returns"]}},"/v1/orders/{id}/invoices":{"get":{"operationId":"InvoicesController_list","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Invoice files attached to the order","tags":["Invoices"]}},"/v1/orders/{id}/invoice":{"post":{"operationId":"InvoicesController_add","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"summary":"Attach your invoice to the order: {fileBase64 | fileUrl, fileName?, invoiceType?, invoiceDate?, warehouse?}","tags":["Invoices"]}},"/v1/invoices":{"get":{"operationId":"InvoicesController_issued","parameters":[{"name":"since","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Documents issued by Bicops to the seller","tags":["Invoices"]}},"/v1/finance/settlements":{"get":{"operationId":"FinanceController_settlements","parameters":[{"name":"from","required":false,"in":"query","schema":{"type":"string"}},{"name":"to","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Per-order settlement: gross, commission, cargo, net, transfer status","tags":["Finance"]}},"/v1/finance/statement":{"get":{"operationId":"FinanceController_statement","parameters":[{"name":"from","required":true,"in":"query","schema":{"type":"string"}},{"name":"to","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Monthly statement: orders, gross, commission, cargo, net, cancelled, transferred","tags":["Finance"]}},"/v1/finance/payments":{"get":{"operationId":"FinanceController_payments","parameters":[{"name":"since","required":true,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Card payments received for the seller’s orders","tags":["Finance"]}},"/v1/reports/sales":{"get":{"operationId":"ReportsController_sales","parameters":[{"name":"from","required":false,"in":"query","schema":{"type":"string"}},{"name":"to","required":false,"in":"query","schema":{"type":"string"}},{"name":"groupBy","required":false,"in":"query","schema":{}}],"responses":{"200":{"description":""}},"summary":"Sales report; groupBy = day | month | product | brand (default last 30 days)","tags":["Reports"]}},"/v1/reports/returns":{"get":{"operationId":"ReportsController_returns","parameters":[{"name":"from","required":true,"in":"query","schema":{"type":"string"}},{"name":"to","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Return rate and reasons","tags":["Reports"]}},"/v1/reports/catalog":{"get":{"operationId":"ReportsController_catalog","parameters":[],"responses":{"200":{"description":""}},"summary":"Catalog health: active, out of stock, without image, without codes","tags":["Reports"]}},"/v1/reports/demand":{"get":{"operationId":"ReportsController_demand","parameters":[{"name":"from","required":true,"in":"query","schema":{"type":"string"}},{"name":"to","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Top-selling products and which of them are out of stock","tags":["Reports"]}},"/v1/webhooks":{"get":{"operationId":"WebhooksController_list","parameters":[],"responses":{"200":{"description":""}},"summary":"Registered webhooks","tags":["Webhooks & Events"]},"post":{"operationId":"WebhooksController_create","parameters":[],"responses":{"201":{"description":""}},"summary":"Register a webhook: {url (https), events?: [order.created, order.status.changed, order.cancelled, shipment.status.changed, return.requested, return.status.changed, catalog.batch.completed, catalog.batch.failed], secret?}","tags":["Webhooks & Events"]}},"/v1/webhooks/{id}":{"delete":{"operationId":"WebhooksController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Disable a webhook","tags":["Webhooks & Events"]}},"/v1/webhooks/{id}/test":{"post":{"operationId":"WebhooksController_test","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Send a test event to the webhook","tags":["Webhooks & Events"]}},"/v1/webhooks/deliveries":{"get":{"operationId":"WebhooksController_deliveries","parameters":[{"name":"eventId","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Delivery log","tags":["Webhooks & Events"]}},"/v1/events":{"get":{"operationId":"WebhooksController_events","parameters":[{"name":"cursor","required":false,"in":"query","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"types","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Event queue for polling clients: ?cursor=<last id>&limit=100&types=order.created,…","tags":["Webhooks & Events"]}},"/v1/customers":{"get":{"operationId":"CorporateController_customers","parameters":[{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"updatedSince","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Customer accounts of the corporate branch","tags":["Corporate"]}},"/v1/customers/{id}/statement":{"get":{"operationId":"CorporateController_statement","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"from","required":true,"in":"query","schema":{"type":"string"}},{"name":"to","required":true,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Customer account statement and balance","tags":["Corporate"]}},"/v1/accounting/receipts":{"get":{"operationId":"CorporateController_receipts","parameters":[{"name":"since","required":true,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Collection receipts","tags":["Corporate"]}},"/v1/accounting/invoices":{"get":{"operationId":"CorporateController_invoices","parameters":[{"name":"since","required":true,"in":"query","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"string"}},{"name":"pageSize","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"summary":"Sales invoices issued by the branch (with items)","tags":["Corporate"]}},"/v1/salesmen":{"get":{"operationId":"CorporateController_salesmen","parameters":[],"responses":{"200":{"description":""}},"summary":"Sales representative assignments","tags":["Corporate"]}}},"info":{"title":"Bicops Partner API","description":"Two-way integration API for sellers and corporate partners of the Bicops marketplace. Authenticate with X-Api-Key + X-Api-Secret. All bulk writes are asynchronous (202 + batchId).","version":"1.0","contact":{}},"tags":[],"servers":[{"url":"https://partner.bicops.tr"}],"components":{"securitySchemes":{"X-Api-Key":{"type":"apiKey","in":"header","name":"X-Api-Key"},"X-Api-Secret":{"type":"apiKey","in":"header","name":"X-Api-Secret"}},"schemas":{"WarehouseStockDto":{"type":"object","properties":{"code":{"type":"string","example":"ANK","description":"Warehouse code — matched against the warehouse aliases defined for your seller account"},"stock":{"type":"number","example":8}},"required":["code","stock"]},"ProductItemDto":{"type":"object","properties":{"sourceId":{"type":"string","example":"SACHS 317 572","description":"Your stock code (business key, immutable)"},"name":{"type":"string","example":"AMORTİSÖR ÖN AUDI A3 / GOLF V"},"brand":{"type":"string","example":"SACHS"},"producerCode":{"type":"string","example":"317 572","description":"Manufacturer part number"},"previousCode":{"type":"string","example":"317 571"},"oemCodes":{"example":["1T0413031CN","1T0413031CK"],"description":"OEM codes — ARRAY; spaces/dashes inside a code are preserved","type":"array","items":{"type":"string"}},"equivalentCodes":{"example":["FEBI 106124"],"description":"Equivalent (cross-reference) codes (brand + code)","type":"array","items":{"type":"string"}},"barcodes":{"type":"array","items":{"type":"string"}},"price":{"type":"number","example":3869.6,"description":"Your list price. Marketplace commission is applied on the Bicops side."},"currency":{"type":"string","example":"TRY","enum":["TRY","USD","EUR"]},"pricesIncludeVat":{"type":"boolean","example":false},"stock":{"type":"number","example":12,"description":"Total sellable stock. If warehouses are given, must equal their sum."},"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/WarehouseStockDto"}},"minOrder":{"type":"number","example":1},"packageAmount":{"type":"number","example":1},"boxAmount":{"type":"number","example":1},"unit":{"type":"string","example":"AD"},"desi":{"type":"number","example":3.2},"weight":{"type":"number","example":1.25,"description":"kilograms"},"images":{"example":["https://cdn.satici.com/317572.jpg"],"type":"array","items":{"type":"string"}},"categoryHint":{"type":"string","example":"Amortisör"},"vehicleHint":{"type":"string","example":"VW Golf V 2003-2008"},"description":{"type":"string"},"status":{"type":"number","example":1,"enum":[0,1],"description":"1 active, 0 inactive (removed from storefront, not deleted)"}},"required":["sourceId"]},"ProductsBatchDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ProductItemDto"}}},"required":["items"]},"StockItemDto":{"type":"object","properties":{"sourceId":{"type":"string","example":"SACHS 317 572"},"stock":{"type":"number","example":12},"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/WarehouseStockDto"}}},"required":["sourceId","stock"]},"StockBatchDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StockItemDto"}}},"required":["items"]},"PriceItemDto":{"type":"object","properties":{"sourceId":{"type":"string","example":"SACHS 317 572"},"price":{"type":"number","example":3999.9},"currency":{"type":"string","example":"TRY"}},"required":["sourceId","price"]},"PriceBatchDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PriceItemDto"}}},"required":["items"]},"ImportCreateDto":{"type":"object","properties":{"format":{"type":"string","example":"ndjson","enum":["ndjson"],"description":"One ProductItem JSON per line; gzip recommended"},"gzip":{"type":"boolean","example":true,"description":"Whether the file is gzip-compressed (.ndjson.gz)"},"dryRun":{"type":"boolean","example":false,"description":"Validate only, write nothing"}}}}}}