Skip to main content
POST
Create Product Listing

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

x-business-number
string

e.g. [Required] User assosiated businessNumber

Content-Type
string
default:application/json

Media type of the JSON request body.

Body

application/json
title
string
required

Product title.

Publicly accessible image URL.

googleProductCategoryId
string
required

Google product taxonomy ID.

price
object
required
status
string
required

Accepted values: PUBLISH, DRAFT.

businessNumbers
any[]

Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.

description
string

Additional public image URLs.

brandName
string
salePrice
object
productSku
string

Merchant SKU; if omitted, system may assign.

productTypes
any[]

Product categorization keywords.

productUrl
string

implant (string, optional)

Response

OK

productId
string

Unique identifier for the product.

code
number

Error code. Present on validation failure.

message
string

Error message. Present on validation failure.

data
object