Skip to main content
POST
Publish Product

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Path Parameters

productId
string
required

OmniCommerce product ID to publish.

Body

application/json
organizationId
string

Optional for API-key requests; required for session-authenticated requests across multiple organizations.

marketplaces
enum<string>[]

Optional marketplaces to publish/update. Omit to target every enabled or already listed marketplace. Duplicates are removed in first-requested order.

Required array length: 1 - 8 elements
Available options:
lazada,
shopee,
tiktok,
shopify,
whatsapp,
zalora,
amazon,
ebay
updateFields
enum<string>[]

Optional fields to publish from saved product data to existing listings only. Omit for all fields. Other fields and listing visibility remain unchanged. Empty/unknown fields are rejected; duplicates are removed. Platform capability limits appear in per-target results.

Required array length: 1 - 9 elements
Available options:
name,
description,
images,
category,
attributes,
highlights,
seo,
price,
inventory
visibility
enum<string>
default:live

Publish visibility mode.

Available options:
live,
draft

Response

Publish jobs queued.

ok
boolean
apiVersion
string
default:developer_v1
operationId
string
status
enum<string>
Available options:
accepted
productId
string
jobId
string
data
object