API Reference

Create a Product

post
https://marketplace-integrations.nelo.co/v1/admin/products

Create a new Product. This API Route can also be used to create a gift card if the is_giftcard field is set to true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the product to create.

string
required

The title of the Product

string

The subtitle of the Product

string

The description of the Product.

boolean
Defaults to false

A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to true will result in a Gift Card being created.

boolean
Defaults to true

A flag to indicate if discounts can be applied to the Line Items generated from this Product

images
array of strings

An array of images of the Product. Each value in the array is a URL to the image. You can use the upload API Routes to upload the image and obtain a URL.

images
string

The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload API Routes to upload the thumbnail and obtain a URL.

string

A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs.

string
enum
Defaults to draft

The status of the product. The product is shown to the customer only if its status is published.

Allowed:
type
object

The Product Type to associate the Product with.

string

The ID of the Product Collection the Product belongs to.

tags
array of objects

Product Tags to associate the Product with.

tags
sales_channels
array of objects

Sales channels to associate the Product with.

sales_channels
categories
array of objects

Product categories to add the Product to.

categories
options
array of objects

The Options that the Product should have. A new product option will be created for every item in the array.

options
variants
array of objects

An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values.

variants
number

The weight of the Product.

number

The length of the Product.

number

The height of the Product.

number

The width of the Product.

string

The Harmonized System code of the Product.

string

The country of origin of the Product.

string

The Manufacturer Identification code of the Product.

string

The material composition of the Product.

metadata
object

An optional set of key-value pairs with additional information.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 11 months ago