Create Product

post

https://sandbox.nmi.com/api/v5/products

Create a new product in the Product Manager. Products can be used in invoices and other payment flows.

Body Params

product_sku

string

required

length ≤ 256

The unique alpha-numeric SKU for this product. An error will be returned if the SKU is already in use by another product.

product_description

string

required

length ≤ 255

The user-facing name of the product.

product_cost

number

required

≥ 0

The cost of the product before any tax or discounts. Format: x.xx

product_currency

string

required

length between 3 and 3

The currency for the product's price (e.g., USD, EUR).

product_commodity_code

string

length ≤ 50

Product commodity code.

product_unit_of_measure

string

length ≤ 3

The unit of measure for the product. Default - NAR

product_tax_amount

number

≥ 0

The tax that should be added to the product cost. This is a fixed amount, not a percentage.

product_discount_amount

number

≥ 0

The discount that will be subtracted from the cost of the product.

product_image_name

string

length ≤ 255

The file name of the image being added with product_image_data. Required for image upload.

product_image_data

string

Image for the product, size must be 2MB or smaller. Format: base64 encoded JPG, PNG, or GIF. Required for image upload.

product_category

string

length ≤ 50

Product category.

Responses

401

Unauthorized

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Product created successfully

400Bad Request - Validation Error